Package Exports
- infiniteflightjs
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (infiniteflightjs) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
InfiniteFlight.js
An Extremely Simple JavaScript Module for V1 of the Infinite Flight Connect API
Installation
Download the latest release, require InfiniteFlight and away you go.
Using the Module
After requiring the module, call InfiniteFlight.init(success, error) to establish the connection to Infinite Flight. This will log the connection details upon success, and call your error function on failure. Neither the success or error functions accept arguments.
To listen for response messages from Infinite Flight, call InfiniteFlight.onMessage(onMsg). The provided function will be executed each time a message is received from Infinite Flight and takes a single argument - the received message in plain text.
To send a command to Infinite Flight call InfiniteFlight.sendCmd(command, params). Command should be a command found in the list of commands found in commands.txt and params should be an array container an object of any necessary parameters. For commands that do not require parameters, this must be set to a blank array - [].
Example
A very simple example showing all features is available in the example folder.
Requirements
- Node.js
dgrammodule - Node.js
netmodule
Contributing
I welcome any contributions to improve this service. Simply fork, change and open a PR. This code is licensed under the GNU GPLv3 License. Bug reports are welcome through the issues feature.