{"id":16461570,"url":"https://github.com/stringbean/drayton-wiser-client","last_synced_at":"2025-02-27T06:24:11.054Z","repository":{"id":57163159,"uuid":"288126635","full_name":"stringbean/drayton-wiser-client","owner":"stringbean","description":"API client for Drayton Wiser heating systems","archived":false,"fork":false,"pushed_at":"2022-01-17T19:44:31.000Z","size":812,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-18T12:45:00.465Z","etag":null,"topics":["drayton-wiser","heating-control"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stringbean.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-17T08:35:21.000Z","updated_at":"2024-04-25T09:25:53.000Z","dependencies_parsed_at":"2022-09-12T08:51:34.078Z","dependency_job_id":null,"html_url":"https://github.com/stringbean/drayton-wiser-client","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stringbean%2Fdrayton-wiser-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stringbean%2Fdrayton-wiser-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stringbean%2Fdrayton-wiser-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stringbean%2Fdrayton-wiser-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stringbean","download_url":"https://codeload.github.com/stringbean/drayton-wiser-client/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240988691,"owners_count":19889547,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["drayton-wiser","heating-control"],"created_at":"2024-10-11T11:08:41.402Z","updated_at":"2025-02-27T06:24:11.033Z","avatar_url":"https://github.com/stringbean.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# drayton-wiser-client\n\n[![Travis](https://img.shields.io/travis/com/stringbean/drayton-wiser-client)](https://travis-ci.com/github/stringbean/drayton-wiser-client)\n[![npm version](https://img.shields.io/npm/v/@string-bean/drayton-wiser-client)](https://www.npmjs.com/package/@string-bean/drayton-wiser-client)\n![node support](https://img.shields.io/node/v-lts/@string-bean/drayton-wiser-client)\n\nThis is heavily based on the [wiserheatingapi](https://github.com/asantaga/wiserheatingapi) Python package and\nthe work by [Julian Knight](https://it.knightnet.org.uk/kb/nr-qa/drayton-wiser-heating-control/).\n\n## Running the example app\n\n1. Obtain the secret key for your system:\n   1. Press the setup button on your HeatHub.\n   2. Connect your phone or PC to the temporary setup Wi-Fi hotspot called `WiserHeatXXX`.\n   3. Fetch the secret using a REST client (or just open in a browser) from: http://192.168.8.1/secret/\n   4. Press the setup button on your HeatHub to exit setup mode.\n2. List the status of your rooms using the demo app:\n   ```shell script\n    npm run demo -- -s $SECRET_KEY list\n   ```\n\n## Using the client\n\nTo create a client pass in the secret and address of the HeatHub, then start calling operations:\n\n```typescript\nimport WiserClient from 'WiserClient';\n\nconst client = WiserClient.clientWithDiscovery('secret');\nconst statuses = await client.roomStatuses();\n\nstatuses.forEach((room) =\u003e {\n  if (room.valid) {\n    console.log(`${room.name}: ${room.temperature}ºc`);\n  } else {\n    console.log(`${room.name}: (invalid)`);\n  }\n});\n```\n\nExamples of each operation can be found in the example app.\n\n## Supported Operations\n\n- System status: `client.systemStatus()`.\n- List room statuses: `client.roomStatuses()`.\n- Single room status: `client.roomStatus(roomId)`.\n- Manually set room target: `client.overrideRoomSetPoint(roomId, setPoint)`.\n- Turn off a room: `client.disableRoom(roomId)`.\n- Cancel room overrides: `client.cancelRoomOverride(roomId)`.\n- Enable away mode: `client.enableAwayMode()`.\n- Disable away mode: `client.disableAwayMode()`.\n- Boost all rooms: `client.boostAllRooms()`.\n- Cancel all room overrides: `client.cancelAllOverrides()`.\n- Fetch the status of everything: `client.fullStatus()`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstringbean%2Fdrayton-wiser-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstringbean%2Fdrayton-wiser-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstringbean%2Fdrayton-wiser-client/lists"}