0.5.0 • Published 4 years ago

express-debug-request v0.5.0

Weekly downloads
1
License
MIT
Repository
github
Last release
4 years ago

Node.js Tydom Client

npm version license build status dependencies status devDependencies status coverage

Easily manage Tydom hardware by Delta Dore from Node.js.

Originally built to enable bridging accessories to Apple HomeKit via the related homebridge-tydom plugin.

  • Rely on node-fetch for the initial HTTP handshake, ws for the websocket connection and http-parser-js to parse incoming messages.

  • Built with TypeScript for static type checking with exported types along the library.

Documentation

Installation

yarn add tydom-client
# or
npm install tydom-client

Debug

This library uses debug to provide high verbosity logs, just pass the following environment:

DEBUG=tydom-client

Examples

Simple example

You can use the provided factory function to quickly get a working client

// Required when testing against a local Tydom hardware
// to fix "self signed certificate" errors
process.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';

const {createClient} = require('tydom-client');
// -or- use named exports (requires babel)
// import {createClient} from 'tydom-client';
// -or- destructure first when using Node.js native modules (eg. `--experimental-modules`)
// import tydomClient from 'tydom-client';
// const {createClient} = tydomClient;

const username = '001A25123456';
const password = 'MyPassw0rd!';
const hostname = 'mediation.tydom.com'; // or '192.168.1.xxx'

const client = createClient({username, password, hostname});

(async () => {
  console.log(`Connecting to "${hostname}"...`);
  const socket = await client.connect();
  // Get Tydom info
  const info = await client.get('/info');
  console.dir({info});
  // Turn a light on
  await client.put(`/devices/${MY_DEVICE_ID}/endpoints/${MY_DEVICE_ID}/data`, [
    {
      name: 'level',
      value: 100
    }
  ]);
  // Listen for external messages
  client.on('message', message => {
    console.dir({message});
  });
})();

Known Tydom interface (wip)

MethodUriDescription
GET/infoget generic tydom information
GET/pingping tydom
GET/devices/dataGet tydom devices data/state
GET/devices/metaGet tydom devices meta
GET/devices/cmetaGet tydom devices command meta
GET/configs/fileGet tydom user config
GET/groups/fileGet tydom groups config
GET/moments/fileGet tydom moments config
GET/scenarios/fileGet tydom scenarios config
GET/protocolsList available protocols
POST/refresh/allForce refresh tydom devices data
GET/devices/${DEVICE_ID}/endpoints/${DEVICE_ID}/dataGET tydom device data/state
PUT/devices/${DEVICE_ID}/endpoints/${DEVICE_ID}/dataUpdate tydom device data/state
PUT/devices/${DEVICE_ID}/endpoints/${DEVICE_ID}/cdata?name=${CMD_NAME}Run tydom device command

Available scripts

ScriptDescription
startalias to spec:watch
testRun all tests
specRun unit tests
spec:coverageRun unit tests with coverage
spec:watchWatch unit tests
lintRun eslint static tests
prettyRun prettier static tests
buildCompile the library
build:watchWatch compilation

Authors

Olivier Louvignes

Credits

License

The MIT License

Copyright (c) 2019 Olivier Louvignes <olivier@mgcrea.io>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.