Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Legacy API

This API has been deprecated in favor of the Software API.

The Legacy API is an extremely basic set of KM-style Mouse commands used to control Ferrum’s functionality from platforms that don’t support the APIs provided by the Ferrum App.

For the latest features avoid using the Legacy API unless absolutely necessary. The only time it should be used is if the user uses Linux for their input pc.

To connect to the Legacy API, please connect directly to the “Silicon Labs CP210x” COM port on your input pc. The starting port speed is 115200. This speed will reset to 115200 every time the device re-powers.

The following sections provide information and pseudocode examples for the different commands available.