Whilst these APIs are useful, they lack any real documentation. Each individual command has a little snippet of documentation, but they can only be spent if the machine is in a certain state. This is not included in any documentation. The user is forced to test via brute force whether a given command can be sent. Currently, the C#* GeneratedCommands.cs file contains over 70,000 lines and hundreds of commands. So even ignoring the fact that the user is being asked brute force test commands, this many commands is infeasible for a user to test or read through.
The solution would be for wrappers to be created that properly encapsulate the slew of commands, providing an actually useable interface for the user. This wrapper would need to be documented.
Without this, there is no hope of development beyond copying then modifying the given examples.
* This is true for C++, C#, and Python. C# is just used as an example.
Whilst these APIs are useful, they lack any real documentation. Each individual command has a little snippet of documentation, but they can only be spent if the machine is in a certain state. This is not included in any documentation. The user is forced to test via brute force whether a given command can be sent. Currently, the C#*
GeneratedCommands.csfile contains over 70,000 lines and hundreds of commands. So even ignoring the fact that the user is being asked brute force test commands, this many commands is infeasible for a user to test or read through.The solution would be for wrappers to be created that properly encapsulate the slew of commands, providing an actually useable interface for the user. This wrapper would need to be documented.
Without this, there is no hope of development beyond copying then modifying the given examples.