\n\nEasily manage [Tydom hardware](https://www.deltadore.fr/domotique/pilotage-maison-connectee/box-domotique/tydom-2-0-ref-6414118) by [Delta Dore](https://www.deltadore.fr/) from [Node.js](https://nodejs.org/en/).\n\nOriginally built to enable bridging accessories to [Apple HomeKit](https://www.apple.com/ios/home/) via the related [homebridge-tydom](https://github.com/mgcrea/homebridge-tydom) plugin.\n\n- Relies on native `fetch` for the initial HTTP handshake, [ws](https://github.com/websockets/ws) for the websocket connection and [http-parser-js](https://github.com/creationix/http-parser-js) to parse incoming messages.\n\n- Built with [TypeScript](https://www.typescriptlang.org/) for static type checking with exported types along the library.\n\n## Documentation\n\n### Installation\n\n```bash\npnpm add tydom-client\n# or\nnpm install tydom-client\n```\n\n### Debug\n\nThis library uses [debug](https://www.npmjs.com/package/debug) to provide high verbosity logs, just pass the following environment:\n\n```bash\nDEBUG=tydom-client\n```\n\n### Command-line Usage\n\n#### Request\n\nRequest (GET) a few known tydom endpoints and store the combined result into a JSON file\n\n```bash\nnpx tydom-client request /configs/file /devices/data /devices/meta /devices/cmeta --file tydom_output.json --username 001A25XXXXXX --password XXXXXX\n```\n\n#### Listen\n\nConnect to the Tydom socket and listen for external events\n\n```bash\nnpx tydom-client listen --username 001A25XXXXXX --password XXXXXX\n```\n\n### Library Usage\n\n#### Simple example\n\nYou can use the provided factory function to quickly get a working client\n\n```js\n// Required when testing against a local Tydom hardware\n// to fix \"self signed certificate\" errors\nprocess.env.NODE_TLS_REJECT_UNAUTHORIZED = '0';\n\nimport {createClient} from 'tydom-client';\n\nconst username = '001A25123456';\nconst password = 'MyPassw0rd!';\nconst hostname = 'mediation.tydom.com'; // or '192.168.1.xxx'\n\nconst client = createClient({username, password, hostname});\n\nconsole.log(`Connecting to \"${hostname}\"...`);\nconst socket = await client.connect();\n// Get Tydom info\nconst info = await client.get('/info');\nconsole.dir({info});\n// Turn a light on\nawait client.put(`/devices/${MY_DEVICE_ID}/endpoints/${MY_DEVICE_ID}/data`, [\n {\n name: 'level',\n value: 100\n }\n]);\n// Listen for external messages\nclient.on('message', (message) => {\n console.dir({message});\n});\n```\n\n### Known Tydom interface (wip)\n\n| **Method** | **Uri** | **Description** |\n| ---------- | --------------------------------------------------------------------- | -------------------------------- |\n| `GET` | `/info` | get generic tydom information |\n| `GET` | `/ping` | ping tydom |\n| `GET` | `/devices/data` | Get tydom devices data/state |\n| `GET` | `/devices/meta` | Get tydom devices meta |\n| `GET` | `/devices/cmeta` | Get tydom devices command meta |\n| `GET` | `/configs/file` | Get tydom user config |\n| `GET` | `/groups/file` | Get tydom groups config |\n| `GET` | `/moments/file` | Get tydom moments config |\n| `GET` | `/scenarios/file` | Get tydom scenarios config |\n| `GET` | `/protocols` | List available protocols |\n| `POST` | `/refresh/all` | Force refresh tydom devices data |\n| `GET` | `/devices/${DEVICE_ID}/endpoints/${DEVICE_ID}/data` | GET tydom device data/state |\n| `PUT` | `/devices/${DEVICE_ID}/endpoints/${DEVICE_ID}/data` | Update tydom device data/state |\n| `PUT` | `/devices/${DEVICE_ID}/endpoints/${DEVICE_ID}/cdata?name=${CMD_NAME}` | Run tydom device command |\n\n### Available scripts\n\n| **Script** | **Description** |\n| ------------- | ---------------------------- |\n| start | Run the CLI with tsx |\n| dev | Run the CLI with debug/watch |\n| test | Run lint + unit tests |\n| spec | Run unit tests |\n| spec:coverage | Run unit tests with coverage |\n| spec:watch | Watch unit tests |\n| lint | Run eslint static tests |\n| format | Run prettier formatting |\n| check | Run TypeScript type checking |\n| build | Compile the library |\n\n## Authors\n\n- [Olivier Louvignes](https://github.com/mgcrea) <>\n\n### Credits\n\n- [depoon/iOSDylibInjectionDemo](https://github.com/depoon/iOSDylibInjectionDemo) for sideloading the iOS app\n- [cth35/tydom_python](https://github.com/cth35/tydom_python) for API discovery\n\n## License\n\n```md\nThe MIT License\n\nCopyright (c) 2020 Olivier Louvignes \n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated\ndocumentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the\nrights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit\npersons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the\nSoftware.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE\nWARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\nCOPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR\nOTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n```\n","readmeFilename":"README.md"}
![\"npm](\"https://img.shields.io/npm/v/tydom-client.svg?style=for-the-badge\")
\n \n \n \n ![\"npm](\"https://img.shields.io/npm/dm/tydom-client.svg?style=for-the-badge\")
\n \n \n ![\"npm](\"https://img.shields.io/npm/l/tydom-client.svg?style=for-the-badge\")
\n \n \n ![\"github](\"https://img.shields.io/github/actions/workflow/status/mgcrea/node-tydom-client/main.yml?style=for-the-badge\")
\n \n