Fix incorrect Marlin position reports in inch mode

README.md

@@ -3,11 +3,13 @@
 [![NPM](https://nodei.co/npm/cncjs-controller.png?downloads=true&stars=true)](https://www.npmjs.com/package/cncjs-controller)
 
 **A controller library for event-based communication between client and CNCjs server**
-
+
+This branch is for CNCjs 2.0.0 or later versions. If you're looking for the previous version (<= 1.9), please visit the [v1](https://github.com/cncjs/cncjs-controller/tree/v1) branch.
+
 ## Installation
 
 ```sh
-npm install --save cncjs-controller
+npm install --save cncjs-controller@latest
 npm install --save [email protected]  # socket.io-client 1.7 is recommended
 ```
 
@@ -18,19 +20,22 @@ import io from 'socket.io-client';
 import Controller from 'cncjs-controller';
 
 const controller = new Controller(io);
-const host = ''; // e.g. http://127.0.0.1:8000
-const token = '<security-token>';
+const host = ''; // or 'http://127.0.0.1:8000'
+const token = '...'; // Authorization token
 const options = {
     query: 'token=' + token
 };
 
 controller.connect(host, options, () => {
-    const port = '/dev/cu.wchusbserialfa130';
+    const controllerType = 'Grbl'; // Grbl|Smoothie|TinyG
+    const connectionType = 'serial'; // serial|socket
+    const serialOptions = {
+        path: '/dev/cu.wchusbserialfa130',
+        baudRate: 115200
+    };
 
-    controller.openPort(port, {
-        controllerType: 'Grbl', // Grbl|Smoothie|TinyG
-        baudrate: 115200
-    }, (err) => {
+    // Open a serial connection
+    controller.open(controllerType, connectionType, serialOptions, (err) => {
         if (err) {
             console.error(err);
             return;
@@ -41,37 +46,320 @@ controller.connect(host, options, () => {
 
     // Disconnect after 60 seconds
     setTimeout(() => {
-        // Close port
-        controller.closePort();
-
-        // Close connection
-        controller.disconnect();
+        controller.close((err) => {
+            controller.disconnect();
+        });
     }, 60 * 1000);
 });
 
-controller.addListener('serialport:open', (options) => {
-    const {
-        port,
-        baudrate,
-        controllerType
-    } = options;
-    console.log(`Connected to the port "${port}" with a baud rate of ${baudrate}.`, { port, baudrate });
+controller.addListener('connection:open', (options) => {
+    const { ident, type, settings } = options;
+
+    if (type === 'serial') {
+        const { path, baudRate } = { ...settings };
+        console.log(`Connected to ${path} with a baud rate of ${baudRate}`);
+    } else if (type === 'socket') {
+        const { host, port } = { ...settings };
+        console.log(`Connected to ${host}:${port}');
+    }
 });
 
-controller.addListener('serialport:close', (options) => {
-    const { port } = options;
-    console.log(`The port "${port}" is disconnected.`);
+controller.addListener('connection:close', (options) => {
+    const { type, settings } = options;
+
+    console.log(`Connection closed: type=${type}, settings=${JSON.stringify(settings)}`);
 });
 
-controller.addListener('serialport:write', (data, context) => {
+controller.addListener('connection:write', (data, context) => {
     console.log('>', data);
 });
 
-controller.addListener('serialport:read', (data) => {
+controller.addListener('connection:read', (data) => {
     console.log('<', data);
 });
 ```
 
+## API Events 
+
+### CNCjs Events
+
+#### Event: 'startup'
+* `data` *(Object)* data object
+* `data.availableControllers` *(Array)* a list of all available controllers
+
+Fired upon system startup.
+
+#### Event: 'config:change'
+
+Fired whenever config changes.
+
+#### Event: 'task:start'
+* `taskId` *(String)* task id
+
+Fired when a task is started.
+
+#### Event: 'task:finish'
+* `taskId` *(String)* task id
+* `code` *(Number)* exit code
+
+Fired when a task is finished.
+
+#### Event: 'task:error'
+* `taskId` *(String)* task id
+* `error` *(Object)* error object
+
+Fired when an error occurred.
+
+#### Event: 'controller:type'
+* `type` *(String)* controller type
+
+Fired when the controller type changes.
+
+#### Event: 'controller:settings'
+* `type` *(String)* controller type
+* `settings` *(Object)* controller settings
+
+Fired when the controller settings changes.
+
+#### Event: 'controller:state'
+* `type` *(String)* controller type
+* `state` *(Object)* controller state
+
+Fired when the controller state changes.
+
+#### Event: 'connection:open'
+* `options` *(Object)* connection options
+
+Fired upon a connection open.
+
+#### Event: 'connection:close'
+* `options` *(Object)* connection options
+
+Fired upon a connection close.
+
+#### Event: 'connection:change'
+* `options` *(Object)* connection options
+* `isOpen` *(Boolean)* True if the connection is open, flase otherwise.
+
+Fired upon a connection change.
+
+#### Event: 'connection:error'
+* `options` *(Object)* connection options
+* `error`*(Object)* error object
+
+Fired upon a connection error.
+
+#### Event: 'connection:read'
+* `options` *(Object)* connection options
+* `data` *(String)* data to read
+
+Fired once a line is received from the connection.
+
+#### Event: 'connection:write'
+* `options` *(Object)* connection options
+* `data` *(String)* data to write
+* `context` *(Object)* associated context information
+
+Fired when writing data to the connection.
+
+#### Event: 'feeder:status'
+* `status` *(Object)* feeder status
+
+Fired when the feeder status changes.
+
+#### Event: 'sender:status'
+* `status` *(Object)* sender status
+
+Fired when the sender status changes.
+
+#### Event: 'sender:load'
+* `data` *(String)* data to load
+* `context` *(Object)* associated context information
+
+Fired when a G-code program is loaded.
+
+#### Event: 'sender:unload'
+
+Fired when a G-code program is unloaded.
+
+#### Event: 'workflow:state'
+* `state` *(String)* workflow state
+
+Fired when the workflow state changes.
+
+#### Event: 'message'
+* `message` *(String)* message string
+
+Fired when the server sends message to the client.
+
+### Socket.IO Events
+
+#### Event: 'connect'
+
+Fired upon a connection including a successful reconnection.
+
+#### Event: 'connect_error'
+* `error` *(Object)* error object
+
+Fired upon a connection error.
+
+#### Event: 'connect_timeout'
+
+Fired upon a connection timeout.
+
+#### Event: 'error'
+* `error` *(Object)* error object
+
+Fired when an error occurs.
+
+#### Event: 'disconnect'
+* `reason` *(String)* either 'io server disconnect' or 'io client disconnect'
+
+Fired upon a disconnection.
+
+#### Event: 'reconnect'
+* `attempt` *(Number)* reconnection attempt number
+
+Fired upon a successful reconnection.
+
+#### Event: 'reconnect_attempt'
+
+Fired upon an attempt to reconnect.
+
+#### Event: 'reconnecting'
+* `attempt` *(Number)* reconnection attempt number
+
+Fired upon a successful reconnection.
+
+#### Event: 'reconnect_error'
+
+Fired upon a reconnection attempt error.
+
+#### Event: 'reconnect_failed'
+
+Fired when couldn't reconnect within `reconnectionAttempts`.
+
+## API Methods
+
+### connect(host = '', options, [callback])
+Establish a connection to the server.
+
+#### Arguments
+1. host <i>(string)</i>:
+2. options <i>(object)</i>:
+3. [callback] <i>(function)</i>: The callback function.
+
+### disconnect([callback])
+Disconnect from the server.
+
+#### Arguments
+1. [callback] <i>(function)</i>: The callback function.
+
+### addListener(eventName, listener)
+Adds the `listener` function to the end of the listeners array for the event named `eventName`.
+
+#### Arguments
+1. eventName <i>(string)</i>: The name of the event.
+2. listener <i>(function)</i>: The listener function.
+
+### removeListener(eventName, listener)
+Removes the specified `listener` from the listener array for the event named `eventName`.
+
+#### Arguments
+1. eventName <i>(string)</i>: The name of the event.
+2. listener <i>(function)</i>: The listener function.
+
+### open(controllerType, connectionType, options, [callback])
+Opens a connection.
+
+#### Arguments
+1. controllerType <i>(string)</i>: One of: 'Grbl', 'Smoothe', 'TinyG'.
+2. connectionType <i>(string)</i>: One of: 'serial', 'socket'.
+3. options <i>(object)</i>: The options object.
+4. options.path <i>(string)</i>: `serial` The serial port referenced by the path.
+5. [options.baudRate=115200] <i>(string)</i>: `serial` The baud rate.
+6. options.host <i>(string)</i>: `socket` The host address to connect.
+7. [options.port=23] <i>(string)</i>: `socket` The port number.
+8. [callback] <i>(string)</i>: Called after a connection is opened.
+
+### close([callback])
+Closes an open connection.
+
+#### Arguments
+1. [callback] <i>(string)</i>: Called once a connection is closed.
+
+### command(cmd, ...args)
+Executes a command on the server.
+
+#### Arguments
+1. cmd <i>(string)</i>: The command to execute.
+
+### write(data, [context)
+Writes data to the open connection.
+
+#### Arguments
+1. data <i>(string)</i>: The data to write.
+2. [context] <i>(object)</i>: The associated context information.
+
+#### writeln(data, [context])
+Writes data and a newline character to the open connection.
+
+#### Arguments
+1. data <i>(string)</i>: The data to write.
+2. [context] <i>(object)</i>: The associated context information.
+
+### getPorts([callback])
+Gets a list of available serial ports.
+
+#### Arguments
+1. [callback] <i>(function)</i>: The error-first callback.
+
+### getBaudRates([callback])
+Gets a list of supported baud rates.
+
+#### Arguments
+1. [callback] <i>(function)</i>: The error-first callback.
+
+### getMachineState()
+Gets the machine state.
+
+#### Return
+<i>(string|number)</i>: Returns the machine state.
+
+### getMachinePosition()
+Gets the machine position.
+
+#### Return
+<i>(object)</i>: Returns a position object which contains x, y, z, a, b, and c properties.
+
+### getWorkPosition()
+Gets the work position.
+
+#### Return
+<i>(object)</i>: Returns a position object which contains x, y, z, a, b, and c properties.
+
+### getModalState()
+Gets modal state.
+
+#### Return
+<i>(object)</i>: Returns the modal state.
+
+## API Properties
+
+Name | Type | Default | Description 
+:--- | :--- | :------ | :----------
+connected | boolean | | Whether the client is connected to the server.
+availableControllers | array | | A list of available controllers.
+type | string | | The controller type. One of: Grbl, Smoothie, TinyG.
+settings | object | | The controller settings.
+state | object | | The controller state.
+connection | object | | The connection object.
+connection.ident | string | | The connection identifier.
+connection.type | string | | The connection type. One of: serial, socket.
+connection.settings | object | | The connection settings.<br>serial: `{ path, baudRate }`<br>socket: `{ host, port }`
+workflow | object | | The workflow object.
+workflow.state | string | | The workflow state. One of: idle, paused, running.
+
 ## License
 
 MIT

package.json

@@ -1,13 +1,13 @@
 {
   "name": "cncjs-controller",
-  "version": "1.3.0",
+  "version": "2.0.0-alpha.1",
   "description": "A controller library for event-based communication between client and CNCjs server.",
   "main": "lib/index.js",
   "scripts": {
     "prepublish": "npm run eslint && npm test && npm run clean && npm run build && npm run dist",
     "build": "babel --out-dir ./lib ./src",
     "dist": "webpack",
-    "clean": "rm -rf lib/*",
+    "clean": "rm -rf lib/* dist/*",
     "eslint": "eslint ./src",
     "test": "tap test/*.js --node-arg=--require --node-arg=babel-register --node-arg=--require --node-arg=babel-polyfill",
     "coveralls": "tap test/*.js --coverage --coverage-report=text-lcov --nyc-arg=--require --nyc-arg=babel-register --nyc-arg=--require --nyc-arg=babel-polyfill | coveralls"