Skip to content

Commit

Permalink
Merge pull request #42 from patrickdown/do-tilt-five-version-check
Browse files Browse the repository at this point in the history 
Add checks for T5 service availability and minimum required version
  • Loading branch information
@patrickdown
patrickdown authored Oct 13, 2023
2 parents 2a64a7e + f25beb8 commit 2f4a3c6
Show file tree
Hide file tree
Showing 7 changed files with 246 additions and 74 deletions.
37 changes: 25 additions & 12 deletions example/addons/tiltfive/T5Manager.gd
View file
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,14 @@ func _enter_tree():
tilt_five_xr_interface = T5Interface.get_tilt_five_xr_interface()

if tilt_five_xr_interface:
tilt_five_xr_interface.service_event.connect(on_service_event)
tilt_five_xr_interface.glasses_event.connect(on_glasses_event)

# Called when the manager is removed
func _exit_tree():
if tilt_five_xr_interface:
tilt_five_xr_interface.glasses_event.disconnect(on_glasses_event)
tilt_five_xr_interface.service_event.disconnect(on_service_event)

tilt_five_xr_interface = null

Expand Down Expand Up @@ -88,10 +90,21 @@ func start_display(glasses_id : StringName, viewport : SubViewport):
func node_name_from_glasses_id(glasses_id: String) -> String:
return "Glasses_" + glasses_id.replace("-", "_")

func on_service_event(event_num):
match event_num:
TiltFiveXRInterface.E_SERVICE_T5_UNAVAILABLE:
print("Tilt Five service is unavailable")
TiltFiveXRInterface.E_SERVICE_T5_INCOMPATIBLE_VERSION:
print("Tilt Five service has an incompatible version")
TiltFiveXRInterface.E_SERVICE_RUNNING:
print("Tilt Five service is running")
TiltFiveXRInterface.E_SERVICE_STOPPED:
print("Tilt Five service has stopped")

func on_glasses_event(glasses_id, event_num):
match event_num:
TiltFiveXRInterface.E_AVAILABLE:
print_verbose(glasses_id, " E_AVAILABLE")
TiltFiveXRInterface.E_GLASSES_AVAILABLE:
print_verbose(glasses_id, " E_GLASSES_AVAILABLE")
if not reserved_glasses.has(glasses_id):
reserved_glasses[glasses_id] = false

Expand All @@ -102,14 +115,14 @@ func on_glasses_event(glasses_id, event_num):
# Let others who are interested know
glasses_available.emit(glasses_id)

TiltFiveXRInterface.E_UNAVAILABLE:
print_verbose(glasses_id, " E_UNAVAILABLE")
TiltFiveXRInterface.E_GLASSES_UNAVAILABLE:
print_verbose(glasses_id, " E_GLASSES_UNAVAILABLE")

# Let others who are interested know
reserved_glasses.erase(glasses_id)

TiltFiveXRInterface.E_RESERVED:
print_verbose(glasses_id, " E_RESERVED")
TiltFiveXRInterface.E_GLASSES_RESERVED:
print_verbose(glasses_id, " E_GLASSES_RESERVED")

reserved_glasses[glasses_id] = true

Expand All @@ -123,8 +136,8 @@ func on_glasses_event(glasses_id, event_num):
# Let others who are interested know
glasses_reserved.emit(glasses_id)

TiltFiveXRInterface.E_DROPPED:
print_verbose(glasses_id, " E_DROPPED")
TiltFiveXRInterface.E_GLASSES_DROPPED:
print_verbose(glasses_id, " E_GLASSES_DROPPED")

var node_name = node_name_from_glasses_id(glasses_id)
var gview = glasses_node.get_node_or_null(node_name)
Expand All @@ -137,12 +150,12 @@ func on_glasses_event(glasses_id, event_num):
reserved_glasses[glasses_id] = false
glasses_dropped.emit(glasses_id)

TiltFiveXRInterface.E_TRACKING:
TiltFiveXRInterface.E_GLASSES_TRACKING:
var gbt = tilt_five_xr_interface.get_gameboard_type(glasses_id)
print_verbose(glasses_id, " E_TRACKING, Gameboard size = ", tilt_five_xr_interface.get_gameboard_extents(gbt))
print_verbose(glasses_id, " E_GLASSES_TRACKING, Gameboard size = ", tilt_five_xr_interface.get_gameboard_extents(gbt))

TiltFiveXRInterface.E_NOT_TRACKING:
print_verbose(glasses_id, " E_NOT_TRACKING")
TiltFiveXRInterface.E_GLASSES_NOT_TRACKING:
print_verbose(glasses_id, " E_GLASSES_NOT_TRACKING")

_:
print_verbose(glasses_id, " - unknown event: ", event_num)
Expand Down
18 changes: 18 additions & 0 deletions extension/T5Integration/StateFlags.h
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,11 +50,29 @@ class StateFlags
return (_current.load() & state) == state;
}

bool is_any_current(FlagType state) const
{
return (_current.load() & state) != 0;
}

bool is_not_current(FlagType state) const
{
return (_current.load() & state) != state;
}

bool any_changed(FlagType state) const
{
return ((_current.load() ^ _previous) & state) != 0;
}

bool became_set(FlagType state) const {
return (_current.load() & state) == state && (_previous & state) != state;
}

bool became_clear(FlagType state) const {
return (_current.load() & state) != state && (_previous & state) == state;
}

void reset_changes()
{
_previous = _current;
Expand Down
113 changes: 94 additions & 19 deletions extension/T5Integration/T5Service.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ std::mutex g_t5_exclusivity_group_2;
T5Service::T5Service() {
_graphics_api = T5_GraphicsApi::kT5_GraphicsApi_None;
_scheduler = ObjectRegistry::scheduler();

_state.clear_all(true);
}

T5Service::~T5Service() {
Expand All @@ -19,11 +21,12 @@ T5Service::~T5Service() {
}

bool T5Service::start_service(const std::string_view application_id, std::string_view application_version) {
if(_state.is_any_current(T5ServiceState::RUNNING | T5ServiceState::STARTING))
return true;
if(_graphics_api == T5_GraphicsApi::kT5_GraphicsApi_None) {
LOG_ERROR("TiltFive graphics api is not set");
return false;
}
if(_is_started) return true;

T5_ClientInfo clientInfo;
clientInfo.applicationId = application_id.data();
Expand All @@ -36,19 +39,19 @@ bool T5Service::start_service(const std::string_view application_id, std::string
return false;
}

_is_started = true;
_state.set(T5ServiceState::STARTING);

_scheduler->start();

_scheduler->add_task(query_ndk_version());
_scheduler->add_task(query_glasses_list());
_scheduler->add_task(startup_checks());

return true;
}

void T5Service::stop_service() {
if(!_is_started) return;
_is_started = false;
if(_state.is_not_current(T5ServiceState::RUNNING))
return;

_state.clear(T5ServiceState::RUNNING);

_scheduler->stop();
for(int i = 0; i < _glasses_list.size(); i++) {
Expand All @@ -73,12 +76,53 @@ std::optional<int> T5Service::find_glasses_idx(const std::string_view glasses_id
return {};
}

CotaskPtr T5Service::query_ndk_version() {

CotaskPtr T5Service::startup_checks() {
bool service_okay = false;
co_await query_t5_service_version();

if(_t5_service_version == "no service" || _t5_service_version == "unknown") {
_state.set(T5ServiceState::T5_UNAVAILABLE);
}
else if(_t5_service_version == "service incompatible") {
_state.set(T5ServiceState::T5_INCOMPATIBLE_VERSION);
}
else {
int major;
int minor;
int revision;

if(sscanf(_t5_service_version.c_str(), "%d.%d.%d", &major, &minor, &revision) == 3) {
if(major >= t5_version_major && minor >= t5_version_minor && revision >= t5_version_revision) {
service_okay = true;
} else {
_state.set(T5ServiceState::T5_INCOMPATIBLE_VERSION);
}
} else {
// If we can't parse the version string somethings wrong
LOG_WARNING("Could not parse Tilt Five version");
_state.set(T5ServiceState::T5_UNAVAILABLE);
}
}
co_await run_in_foreground;

if(service_okay) {
_state.clear(T5ServiceState::STARTING);
_state.set(T5ServiceState::RUNNING);
_scheduler->add_task(query_glasses_list());
}
else {
stop_service();
}

}

CotaskPtr T5Service::query_t5_service_version() {
std::vector<char> buffer;
size_t buffer_size = 32;
buffer.resize(buffer_size);

T5_Result result;
T5_Result result = T5_ERROR_IO_FAILURE;
for(int tries = 0; tries < 10; ++tries) {
size_t buffer_size = buffer.size();
{
Expand All @@ -88,22 +132,33 @@ CotaskPtr T5Service::query_ndk_version() {
if(result == T5_ERROR_OVERFLOW) {
buffer.resize(buffer_size);
continue;
}
else if(result != T5_ERROR_NO_SERVICE && result != T5_ERROR_IO_FAILURE) {
}
else if(result == T5_TIMEOUT &&
result != T5_ERROR_NO_SERVICE &&
result != T5_ERROR_IO_FAILURE) {
break;
}
co_await task_sleep(_poll_rate_for_retry);
}
co_await run_in_foreground;
if(result != T5_SUCCESS) {
if(result == T5_SUCCESS) {
buffer.resize(buffer_size);
_t5_service_version = buffer.data();
}
else if(result == T5_ERROR_NO_SERVICE) {
LOG_T5_ERROR(result);
_t5_service_version = "no service";
}
else if(result == T5_ERROR_SERVICE_INCOMPATIBLE) {
LOG_T5_ERROR(result);
_ndk_version = "unknown";
_t5_service_version = "service incompatible";
}
else {
buffer.resize(buffer_size);
_ndk_version = buffer.data();
LOG_T5_ERROR(result);
_t5_service_version = "unknown";
}
log_message("Tilt Five NDK version: ", _ndk_version);

log_message("Tilt Five NDK version: ", _t5_service_version);
}

CotaskPtr T5Service::query_glasses_list() {
Expand Down Expand Up @@ -171,7 +226,7 @@ std::unique_ptr<Glasses> T5Service::create_glasses(const std::string_view id) {
}

bool T5Service::is_service_started() {
return _is_started;
return _state.is_current(T5ServiceState::RUNNING);
}

void T5Service::reserve_glasses(int glasses_num, const std::string_view display_name) {
Expand Down Expand Up @@ -207,7 +262,7 @@ void T5Service::update_connection() {
}

void T5Service::update_tracking() {
if(!_is_started)
if(!is_service_started())
return;

_scheduler->schedule_tasks();
Expand All @@ -221,7 +276,27 @@ void T5Service::update_tracking() {
tracking_updated();
}

void T5Service::get_events(std::vector<GlassesEvent>& out_events) {
void T5Service::get_service_events(std::vector<T5ServiceEvent>& out_events) {

auto changes = _state.get_changes();
auto current_state = _state.get_current();

if(_state.became_set(T5ServiceState::T5_UNAVAILABLE)) {
out_events.push_back(T5ServiceEvent(T5ServiceEvent::E_T5_UNAVAILABLE));
}
if(_state.became_set(T5ServiceState::T5_INCOMPATIBLE_VERSION)) {
out_events.push_back(T5ServiceEvent(T5ServiceEvent::E_T5_INCOMPATIBLE_VERSION));
}
if(_state.became_set(T5ServiceState::RUNNING)) {
out_events.push_back(T5ServiceEvent(T5ServiceEvent::E_RUNNING));
}
if(_state.became_clear(T5ServiceState::RUNNING)) {
out_events.push_back(T5ServiceEvent(T5ServiceEvent::E_STOPPED));
}
_state.reset_changes();
}

void T5Service::get_glasses_events(std::vector<GlassesEvent>& out_events) {
for(int i = 0; i < _glasses_list.size(); ++i) {
_glasses_list[i]->get_events(i, out_events);
}
Expand Down
Loading

0 comments on commit 2f4a3c6

Please sign in to comment.