1.0.1 • Published 10 months ago

@csllc/cs1520 v1.0.1

Weekly downloads
-
License
MIT
Repository
-
Last release
10 months ago

CS1520

This package provides a javascript (nodejs) module that interfaces with the Control Solutions Geofencing products (eg CS1520-1, CS1521-1).

For usage examples, refer to the test or example folders.

Development

When making improvements or fixes to this package, please follow the existing coding/formatting conventions. The original author used the VS Code editor with automatic formatting provided by Prettier and ESLint.

Testing

The mocha-based test system can checks both the javascript code execution, and the operation of an attached 'live' device.

The npm test command runs only javascript module tests and does not require an attached device. This is suitable for a CI/CD environment when it is not feasible to have an attached device.

The npm run test-live interfaces with a CS1521-1 or CS1520-1 device and runs tests, producing an HTML-formatted test report in the ./report folder.

Debugging

Setting either or both of these environment variables enables debug console output using the standard nodejs debug package.

@csllc/cs1520 outputs information useful for tracing and troubleshooting @csllc/cs1520:serial outputs detailed information about each serial port message sent and received