Skip to content

Commit

Permalink
Merge branch 'custom-key-events' into next
Browse files Browse the repository at this point in the history
  • Loading branch information
@mpaperno
mpaperno committed Mar 2, 2024
2 parents dbd4c46 + 340dd34 commit 61912e6
Show file tree
Hide file tree
Showing 5 changed files with 380 additions and 83 deletions.
122 changes: 96 additions & 26 deletions src/Testing/CPP_BasicConsole/CPP_BasicConsole.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,21 +80,24 @@ static const auto getEnumName(Enum e, const Range &range) noexcept
// This is an event handler for printing Client and Server log messages.
static void LogHandler(const LogRecord &lr, LogSource src)
{
Log("@@")() << getEnumName(src, LogSourceNames) << ": " << lr; // LogRecord has a convenient stream operator
Log("@@")() << getEnumName(src, LogSourceNames) << ": " << lr; // LogRecord has a convenient stream operator
}

// Handler to print the current Client status (connecting, disconnected, etc).
static void ClientStatusHandler(const ClientEvent &ev)
{
Log("^^")() << "Client event " << getEnumName(ev.eventType, ClientEventTypeNames) << " - " << quoted(ev.message) << "; Client status: " << hex << setw(2) << setfill('0') << (uint16_t)ev.status;
Log("^^")() << "Client event " << getEnumName(ev.eventType, ClientEventTypeNames) << " - " << quoted(ev.message)
<< "; Client status: " << hex << setw(2) << setfill('0') << (uint16_t)ev.status;
}

// Event handler for showing listing results (eg. local vars list)
static void ListResultsHandler(const ListResult &lr)
{
Log()() << "ListResult{ " << getEnumName(lr.listType, LookupItemTypeNames) << "; status: " << hex << setw(8) << setfill('0') << lr.result << " Values: ";
for (const auto & [k, v] : lr.list)
Log("\t")() << k << " = " << v;
Log()() << "Got " << lr.list.size() << " results for list type " << getEnumName(lr.listType, LookupItemTypeNames) << ". (Uncomment next line in ListResultsHandler() to print them.)";
// uncomment below to print list results (may be long)
// for (const auto & [k, v] : lr.list) Log("\t")() << k << " = " << v;
// Log()() << "End of list results.";

// signal completion
SetEvent(g_dataUpdateEvent);
}
Expand All @@ -118,6 +121,15 @@ static void DataSubscriptionHandler(const DataRequestRecord &dr)
SetEvent(g_dataUpdateEvent);
}

// Helper function to wait for data to arrive or time out with a log message.
static bool AwaitData(DWORD ms = 1000)
{
if (WaitForSingleObject(g_dataUpdateEvent, ms) == WAIT_OBJECT_0)
return true;
Log("!!")() << "Data subscription update timed out!";
return false;
}

// -----------------------------
// Main
// -----------------------------
Expand All @@ -143,7 +155,7 @@ int main()

HRESULT hr; // store method invocation results for logging

// Connect to Simulator (SimConnect) using default timeout period and network configuration (local Simulator)
// Connect to Simulator (SimConnect) using default timeout period and network configuration (local Simulator)
if ((hr = client.connectSimulator()) != S_OK) {
Log("XX")() << "Cannot connect to Simulator, quitting. Error Code: " << hr;
return -1;
Expand All @@ -169,7 +181,7 @@ int main()
const string simVarUnit = "percent";

// Execute a calculator string with result. We'll try to read the value of the SimVar defined above.
const string calcCode = (ostringstream() << "(A:" << simVarName << ',' << simVarUnit).str();
string calcCode = (ostringstream() << "(A:" << simVarName << ',' << simVarUnit << ')').str(); // "(A:CG PERCENT,percent)"
double fResult = 0.;
string sResult {};
if (client.executeCalculatorCode(calcCode, CalcResultType::Double, &fResult, &sResult) == S_OK)
Expand All @@ -194,7 +206,8 @@ int main()
// Assuming our variable was created/exists, lets "subscribe" to notifications about when its value changes.
// First set up the event handler to get the updates.
client.setDataCallback(DataSubscriptionHandler);
// We subscribe to it using a "data request" and set it up to return as a float value, using a predefined value type (we could also use `4` here, for the number of bytes in a float).

// We subscribe to it using a "data request" and set it up to return as a float value, using a predefined value type (DATA_TYPE_FLOAT).
// This should also immediately return the current value, which will be delivered to the DataSubscriptionHandler we assigned earlier.
if (client.saveDataRequest(DataRequest(REQUEST_ID_1_FLOAT, 'L', variableName.c_str(), DATA_TYPE_FLOAT)) == S_OK)
Log()() << "Subscribed to value changes for local variable " << quoted(variableName);
Expand All @@ -206,65 +219,122 @@ int main()
else
break;
// wait for updates to process asynchronously and our event handler to get called, or time out
if (WaitForSingleObject(g_dataUpdateEvent, 1000) != WAIT_OBJECT_0) {
Log("!!")() << "Data subscription update timed out!";
if (!AwaitData())
break;
}
}

// Test subscribing to a string type value. We'll use the Sim var "TITLE" (airplane name), which can only be retrieved using calculator code.
// We allocate 32 Bytes here to hold the result and we request this one with an update period of Once, which will return a result right away
// We allocate 64 Bytes here to hold the result and we request this one with an update period of Once, which will return a result right away
// but will not be scheduled for regular updates. If we wanted to update this value later, we could call the client's `updateDataRequest(requestId)` method.
Log(">>")() << "Requesting TITLE variable...";
hr = client.saveDataRequest(DataRequest(
/*requestId*/ REQUEST_ID_2_STR,
/*resultType*/ CalcResultType::String,
/*calculatorCode*/ "(A:TITLE, String)",
/*valueSize*/ 32,
/*valueSize*/ 64,
/*period*/ UpdatePeriod::Once)
);
if (hr == S_OK) {
Log(">>")() << "Requested TITLE variable.";
if (WaitForSingleObject(g_dataUpdateEvent, 1000) != WAIT_OBJECT_0)
Log("!!")() << "Data subscription update timed out!";
}
if (hr == S_OK)
AwaitData();
else
Log("!!")() << "saveDataRequest() for TITLE var returned error result " << hr;

// Test getting a list of our data requests back from the Client.
Log("::")() << "Saved Data Requests:";
const auto &requests = client.dataRequests();
for (const DataRequestRecord &dr : requests)
Log()() << dr; // Another convenient stream operator for logging

// OK, that was fun... now remove the data subscriptions. We could have done it in the loop above but we're testing things here...
// The server will also remove all our subscriptions when we disconnect, but it's nice to be polite!
const vector<uint32_t> &requestIds = client.dataRequestIdsList();
for (const uint32_t &id :requestIds)
client.removeDataRequest(id);
// Test removing a data subscriptions.
if ((hr = client.removeDataRequest(REQUEST_ID_2_STR)) != S_OK)
Log("!!")() << "removeDataRequest() for TITLE var returned error result " << hr;

// Get a list of all local variables...
// Connect to the list results Event
client.setListResultsCallback(ListResultsHandler);
// Request the list.
client.list(LookupItemType::LocalVariable);
// Results will arrive asynchronously, so we wait a bit.
if (WaitForSingleObject(g_dataUpdateEvent, 3000) != WAIT_OBJECT_0)
Log("!!")() << "List results timed out!";
AwaitData(3000);

// Look up a Key Event ID by name;
const string eventName = "ATC_MENU_OPEN"; // w/out the "KEY_" prefix.
int keyId = -1;
if (client.lookup(LookupItemType::KeyEventId, eventName, &keyId) == S_OK)
Log("<<")() << "Got lookup ID: 0x " << hex << setw(8) << setfill('0') << keyId << " for " << quoted(eventName);

// Trigger the event we just looked up (it won't actually work since all the "ATC_MENU" events are broken in MSFS).
client.sendKeyEvent(keyId);

// Try sending a Command directly to the server and wait for a response (Ack/Nak).
// In this case we'll use a "SendKey" command to activate a Key Event by the ID which we just looked up
// (which does the same thing we just did above with `sendKeyEvent()`).
Command response;
if (client.sendCommandWithResponse(Command(CommandId::SendKey, keyId), &response) == S_OK)
Log("<<")() << "Got response for SendKey command: " << response; // another custom stream op

// Custom calculator event tests.

// Let's say we want a simple way to toggle a variable value using some RPN code (or repeatedly execute any kind of calculator code).
// We could use `executeCalculatorCode()` each time, but this isn't very efficient because the code string has to be built, sent,
// parsed, compiled on the sim side, and then finally executed. Using pre-defined "calculator events" we can skip all the preliminary
// steps and simply trigger the execution of pre-compiled RPN code via a numeric event ID.
//
// For this test we're just going to toggle the test Local variable we created earlier between the values of 0 and 1 based on its current value,
// using the following basic RPN code:
// (L:WASIM_TEST_VAR_1) 1 == if{ 0 (>L:WASIM_TEST_VAR_1) } els{ 1 (>L:WASIM_TEST_VAR_1) }
calcCode = (ostringstream() <<
"(L:" << variableName << ") 1 == if{ 0 (>L:" << variableName << ") } els{ 1 (>L:" << variableName << ") }"
).str();

// We need to register that calculator code with the WASim client/server, and we'll use a unique ID to refer to this event later on.
// The ID is arbitrary (just like request IDs) -- it could be an const enum value, dynamically generated, or whatever else ensures a unique number per event.
const uint32_t customEventId = 1;
// We can, optionally, also provide our own name for this custom event when we register it.
// This name could be used to trigger this custom event from _any_ standard SimConnect client (by mapping to the name using `SimConnect_MapClientEventToSimEvent()`
// and then triggering with `SimConnect_TransmitClientEvent[_EX1]()`).
// We don't really need a custom name for this example, but we can actually make use of this later to test another feature.
hr = client.registerEvent(RegisteredEvent(customEventId, calcCode, "MyEvents.ToggleTestVariable"));
if (hr == S_OK) {
// Assuming that worked, we can now trigger the custom event in various ways. Since we're still "watching" the test local variable for changes,
// we should see a new value every time we trigger this event.
if ((hr = client.transmitEvent(customEventId)) == S_OK)
AwaitData();
else
Log("!!")() << "transmitEvent() returned error result " << hr;
}
else {
Log("!!")() << "Registration of custom calculator event ID " << customEventId << " with RPN code " << quoted(calcCode) << " failed with error: " << hr;
}

// Custom named event registration and triggering test (new for v1.3.0).
// This tests setting up a custom-named simulator event, which are typically created by 3rd-party aircraft models, such as the FlyByWire A32NX.
// Here we're (redundantly) using our own custom-named "calculator event" we set up above, just because we know it exists (vs. relying on some specific model to be installed).

// First the custom-named event needs to be registered with the client. Note we're using the same event name here as we used in the `registerEvent()` call above.
// This sets up a SimConnect mapping to a generated unique ID. We want to save this ID and use it later to trigger the event efficiently (w/out needing to use the event name again).
uint32_t customNamedEventId = 0;
hr = client.registerCustomKeyEvent("MyEvents.ToggleTestVariable", &customNamedEventId);
if (hr == S_OK) {
// A successful registration means we can now use the generated event ID to trigger the custom event,
// using the same `sendKeyEvent()` method as we'd use for a "standard" Key Event.
Log()() << "registerCustomKeyEvent() succeeded, returned Event ID " << customNamedEventId;
// Trigger the event. Should get a variable value change message after this, or a timeout if something went wrong.
if ((hr = client.sendKeyEvent(customNamedEventId)) == S_OK)
AwaitData();
else
Log("!!")() << "sendKeyEvent() returned error result " << hr;
}
else {
Log("!!")() << "registerCustomKeyEvent() returned error result " << hr;
}

// Finished, disconnect.

// Shutdown (really the destructor will close any/all connections anyway, but this is for example).
client.disconnectServer();
client.disconnectSimulator();

CloseHandle(g_dataUpdateEvent);
return 0;
}

Loading

0 comments on commit 61912e6

Please sign in to comment.