https://github.com/pgerke/freeathome-local-api-sample
A Node.JS script illustrating the use of the freeathome-local-api-client.
https://github.com/pgerke/freeathome-local-api-sample
freeathome local-api
Last synced: 6 months ago
JSON representation
A Node.JS script illustrating the use of the freeathome-local-api-client.
- Host: GitHub
- URL: https://github.com/pgerke/freeathome-local-api-sample
- Owner: pgerke
- License: mit
- Created: 2022-05-09T14:09:42.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-07-16T15:28:44.000Z (almost 2 years ago)
- Last Synced: 2025-01-25T19:02:50.963Z (over 1 year ago)
- Topics: freeathome, local-api
- Language: JavaScript
- Homepage:
- Size: 20.5 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# freeathome-local-api-sample
A Node.JS script illustrating the use of the [freeathome-local-api-client](https://github.com/pgerke/freeathome-local-api-client).
This script demonstrates how to connect to the Busch-Jaeger free@home System Access Point (SysAP) and control devices such as lights, shutters, and heating systems. It provides a basic example of how to use the client library to interact with the free@home systems local API.
**This is a demo repository and will not be actively maintained!**
## Usage Instructions
1. Install dependencies
```
npm install
```
2. Create an .env file
You'll need to provide the System Access Point host name, the user ID and the password to create a connection. I'd recomment setting up a `.env` file
```
SYSAP_HOST=
SYSAP_USER_ID=
SYSAP_PASSWORD=
```
3. Run the script
You can start the script now. Please note, that you'll need to provide real device IDs and corresponding channels for the script to work.
```
npm run start
```
## Non-Affiliation Disclaimer
This library is not endorsed by, directly affiliated with, maintained, authorized, or sponsored by Busch-Jaeger Elektro GmbH or ABB Asea Brown Boveri Ltd or . All product and company names are the registered trademarks of their original owners. The use of any trade name or trademark is for identification and reference purposes only and does not imply any association with the trademark holder of their product brand.
## License
The project is subject to the MIT license unless otherwise noted. A copy can be found in the root directory of the project [LICENSE](./LICENSE).
Made with ❤️ by [Philip Gerke](https://github.com/pgerke)