Mission Control Client – mission-control-client

A client for Node.js and the browser to easily connect and interact with the Mission Control system.

Docs

This mission-control-client is used to simplify my custom applications that I write for the Mission Control home automation system. This library makes it very easy to add features to every little thing I built for it.

Installation

npm install mission-control-client --save

Usage Examples

The library can then be used like this:

import { MissionControlClient } from 'mission-control-client';

const client = new MissionControlClient('http://localhost', '<API-KEY>');

// Listen to socket events
client.on('connect', () => {
	console.log('We have a connection');
});

client.on('disconnect', reason => {
	console.log('Disconnected again for reason:', reason);
});

// Listen to mission control events.
client.subscribe('action:VIDEO-QUEUE:PUSH', data => {
	/* ... */
});
client.subscribe('update:videoQueue', data => {
	/* ... */
});

// Run an action
client.action('NOTIFICATION:CREATE', {
	/* data */
});

For more examples and usage, please refer to the Docs.

Handling Auth

Auth is done using JSON Web Tokens. Due to a limitation in Socket.io, we can't detect an 'unauthorized' response, as Socket.io simply won't send any responses before we authenticated. Keep that in mind if you run into connection errors as they might be auth-based. Check the Mission Control console, it will tell you if a socket client is unauthorized.

Development Setup

Describe how to install all development dependencies and how to run an automated test-suite of some kind. Potentially do this for multiple platforms.

# To build the docs
npm run docs

# To build
npm run build

Release History

• 1.1.0
  • Changed authentication scheme. Client now sends authentication data over secure body packets instead of querystring parameters, which were visible on insecure connections.
  • Added AUTH_INVALID_TOKEN and AUTH_TIMEOUT socket error types.
• 1.0.0
  • The first proper release

Authors

Lukas Mateffy – @Capevace – mateffy.me

Distributed under the MIT license. See LICENSE for more information.

Contributing

1. Fork it (https://github.com/capevace/mission-control-client/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request