|
| 1 | +# cncjs-controller [](https://travis-ci.org/cncjs/cncjs-controller) [](https://coveralls.io/github/cncjs/cncjs-controller?branch=master) |
| 2 | + |
| 3 | +[](https://www.npmjs.com/package/cncjs-controller) |
| 4 | + |
| 5 | +**A controller library for event-based communication between client and CNCjs server** |
| 6 | + |
| 7 | + |
| 8 | + |
| 9 | +## Installation |
| 10 | + |
| 11 | +```sh |
| 12 | +npm install --save cncjs-controller |
| 13 | +npm install --save [email protected] # socket.io-client 1.7 is recommended |
| 14 | +``` |
| 15 | + |
| 16 | +## Usage |
| 17 | + |
| 18 | +```js |
| 19 | +import io from 'socket.io-client'; |
| 20 | +import Controller from 'cncjs-controller'; |
| 21 | + |
| 22 | +const controller = new Controller(io); |
| 23 | +const host = ''; // e.g. http://127.0.0.1:8000 |
| 24 | +const token = '<security-token>'; |
| 25 | +const options = { |
| 26 | + query: 'token=' + token |
| 27 | +}; |
| 28 | + |
| 29 | +controller.connect(host, options, () => { |
| 30 | + const port = '/dev/cu.wchusbserialfa130'; |
| 31 | + |
| 32 | + controller.openPort(port, { |
| 33 | + controllerType: 'Grbl', // Grbl|Smoothie|TinyG |
| 34 | + baudrate: 115200 |
| 35 | + }, (err) => { |
| 36 | + if (err) { |
| 37 | + console.error(err); |
| 38 | + return; |
| 39 | + } |
| 40 | + |
| 41 | + controller.writeln('$$'); // View Grbl Settings |
| 42 | + }); |
| 43 | + |
| 44 | + // Disconnect after 60 seconds |
| 45 | + setTimeout(() => { |
| 46 | + // Close port |
| 47 | + controller.closePort(); |
| 48 | + |
| 49 | + // Close connection |
| 50 | + controller.disconnect(); |
| 51 | + }, 60 * 1000); |
| 52 | +}); |
| 53 | + |
| 54 | +controller.on('serialport:open', (options) => { |
| 55 | + const { |
| 56 | + port, |
| 57 | + baudrate, |
| 58 | + controllerType |
| 59 | + } = options; |
| 60 | + console.log(`Connected to the port "${port}" with a baud rate of ${baudrate}.`, { port, baudrate }); |
| 61 | +}); |
| 62 | + |
| 63 | +controller.on('serialport:close', (options) => { |
| 64 | + const { port } = options; |
| 65 | + console.log(`The port "${port}" is disconnected.`); |
| 66 | +}); |
| 67 | + |
| 68 | +controller.on('serialport:write', (data, context) => { |
| 69 | + console.log('>', data); |
| 70 | +}); |
| 71 | + |
| 72 | +controller.on('serialport:read', (data) => { |
| 73 | + console.log('<', data); |
| 74 | +}); |
| 75 | +``` |
| 76 | + |
| 77 | +## License |
| 78 | + |
| 79 | +MIT |
0 commit comments