https://github.com/capevace/mission-control-client
JavaScript SDK for external sites & services to connect to Mission Control. Works on browser and in Node.
https://github.com/capevace/mission-control-client
browser javascript library mission-control nodejs npm
Last synced: about 2 months ago
JSON representation
JavaScript SDK for external sites & services to connect to Mission Control. Works on browser and in Node.
- Host: GitHub
- URL: https://github.com/capevace/mission-control-client
- Owner: Capevace
- License: mit
- Created: 2019-05-22T07:21:01.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T22:49:24.000Z (over 3 years ago)
- Last Synced: 2025-03-17T23:41:50.012Z (over 1 year ago)
- Topics: browser, javascript, library, mission-control, nodejs, npm
- Language: JavaScript
- Homepage: https://mission-control.js.org
- Size: 4.08 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Mission Control Client – mission-control-client
> A client for Node.js and the browser to easily connect and interact with the Mission Control system.
[![NPM Version][npm-image]][npm-url]
[![Downloads Stats][npm-downloads]][npm-url]
##### [Docs][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
```sh
npm install mission-control-client --save
```
## Usage Examples
The library can then be used like this:
```js
import { MissionControlClient } from 'mission-control-client';
const client = new MissionControlClient('http://localhost', '');
// 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][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.
```sh
# 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](https://twitter.com/capevace) – [mateffy.me](https://mateffy.me)
Distributed under the MIT license. See `LICENSE` for more information.
## Contributing
1. Fork it ()
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
[npm-image]: https://img.shields.io/npm/v/mission-control-client.svg?style=flat-square
[npm-url]: https://npmjs.org/package/mission-control-client
[npm-downloads]: https://img.shields.io/npm/dm/mission-control-client.svg?style=flat-square
[wiki]: https://github.com/capevace/mission-control-client/wiki
[docs]: https://capevace.github.io/mission-control-client