Skip to content

Commit

Permalink
Update CHANGELOG and README.
Browse files Browse the repository at this point in the history
  • Loading branch information
mpaperno committed Oct 18, 2022
1 parent 7a8051d commit 3e671f9
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 10 deletions.
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,34 @@
# WASimCommander - Change Log

## 1.1.0.0 (TBD)
Updates for MSFS 2020 SU10 changes and new features.

### WASimModule
* Added new feature to trigger simulator Key Events with multiple value parameters (Gauge API `trigger_key_event_EX1()`).
* Removed ability to get or set Local type variables with Unit specifiers (turns out MSFS hasn't supported this from the start).
* Added Key Event lookup names for new KEY_PROP_FORCE_BETA_* events.
* Added Token variable name lookups for CIRCUIT_NAVCOM4_ON and BREAKER_NAVCOM4.
* Remove usage of deprecated `send_key_event()` for `SendKey` command in favor of `trigger_key_event_EX1()`.

### WASimClient
* Added `sendKeyEvent()` methods for sending simulator Key Events with up to 5 values, either by event ID or by name.
* Unit type specifiers for getting/setting Local variables are ignored (no longer sent to the server even if provided in the method call).

### WASimClient_CLI
* Added `sendKeyEvent()` methods (see above).
* Re-targeted for VS2022, VC v143 and .NET 6.0.
* Added .NET Framework target.

### WASimUI
* Added new form for sending Key Events with up to 5 value parameters.
* Added connected WASimModule (server) version number display.
* Fixed that the calculation result display text field could not be cleared.

---
## 1.0.0.9 (unreleased)
* No changes from 1.0.0.8-rc1.

---
## 1.0.0.8-rc1 (2-Aug-2022)
### WASimClient (and dependents)
* Fix possible SimConnect exception (Sim crash) when removing data request subscriptions. Seemed to only happen occasionally and when SimConnect was under load from other clients.
Expand Down
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,8 @@ On a more practical note, I am using it with the [MSFS Touch Portal Plugin](http
- Registered events can be executed "natively" via _WASim API_ by simply sending a short command with the saved event ID.
- Saved events can also be named and executed via standard SimConnect commands `SimConnect_MapClientEventToSimEvent(id, "event_name")` and `SimConnect_TransmitClientEvent(id)`.
- Event names can be completely custom (including a `.` (period) as per SimConnect convention), or derive from the connected Client's name (to ensure uniqueness).
- **Send Simulator "Key Events"** directly by ID (instead of going through the SimConnect mapping process or executing calculator code). Much more efficient than the other methods.
- **Send Simulator "Key Events"** directly by ID or name (instead of going through the SimConnect mapping process or executing calculator code). Much more efficient than the other methods.
- **New in v1.1.0:** Send Key Events with up to 5 values (like the new `SimConnect_TransmitClientEvent_EX1()`).
- **Remote Logging**: Log messages (errors, warnings, debug, etc) can optionally be sent to the Client, with specific minimum level (eg. only warnings and errros).
- **Ping** the Server to check that the WASM module is installed and running before trying to connect or use its features.

Expand Down Expand Up @@ -166,15 +167,6 @@ Use [Discussions](https://github.com/mpaperno/WASimCommander/discussions) for an
Most flight simulator forums seem fairly strict about _not_ using their site to provide product support. So please use GitHub,
unless you're absolutely sure no rules would be broken or toes stepped upon otherwise.

-------------
### Known Issues

- Setting a Local Variable value with the `Set` command ignores any Unit specifier. This is due to a bug in the MSFS WASM library
preventing the corresponding _Gauge API_ function `set_named_variable_typed_value()` from being exported.
See bug report at [devsupport.flightsimulator.com](https://devsupport.flightsimulator.com/questions/8604/env-wasm-set-named-variable-typed-value-not-found.html)

You can stil use a unit specifier with L vars in calculaotor code. Though I've yet to find an instance where it makes any difference.

-------------
### Credits

Expand Down

0 comments on commit 3e671f9

Please sign in to comment.