Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/trickfilm400/senertec-dachs-msr2
SenerTec Dachs MSR2 GLT-Ethernet REST API Client
https://github.com/trickfilm400/senertec-dachs-msr2
api api-wrapper dachs glt msr2 nodejs nodejs-api npm npm-package rest rest-api rest-client senertec typescript
Last synced: 2 days ago
JSON representation
SenerTec Dachs MSR2 GLT-Ethernet REST API Client
- Host: GitHub
- URL: https://github.com/trickfilm400/senertec-dachs-msr2
- Owner: Trickfilm400
- License: mit
- Created: 2022-02-20T12:27:02.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-09-12T04:31:26.000Z (2 months ago)
- Last Synced: 2024-10-12T13:52:30.299Z (about 1 month ago)
- Topics: api, api-wrapper, dachs, glt, msr2, nodejs, nodejs-api, npm, npm-package, rest, rest-api, rest-client, senertec, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/@trickfilm400/senertec-dachs-msr2
- Size: 89.8 KB
- Stars: 3
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# senertec-dachs-msr2
This NPM package provides a full nodejs-api for the Dachs-Ethernet-Card-HTTP-Api.
# Usage
- Install npm package with
```shell
npm i @trickfilm400/senertec-dachs-msr2
```
- To see the complete list of all keys to fetch, visit the `lib/ReadKeyList.ts` file in the source code.
There is a short description and the unit given.
Use the JSON path as in the example below and select the keys you need to fetch manually.
## Typescript Example
```typescript
import {IReadKeyList, KeyListEntityResponse, SenerTecDachsClientMSR2} from "@trickfilm400/senertec-dachs-msr2";
const client = new SenerTecDachsClientMSR2({
host: "http://192.168.178.225",
//protocol: "http",
//port: 80,
username: "glt",
password: "",
resultConfig: {
//addRawValue: false,
addKeyObject: false
}
});
//fetch 4 predefined keys as written in the 'lib/index.ts' file.
//You probably don't need this if you want to fetch specific data
client.fetchUsefulData().then(result => {
console.log(result)
});
// OR
//fetch specified keys manually
client.fetchKeys(
//betriebsdaten
client.ReadKeyList.Hka_Bd.ulAnzahlStarts.key,
client.ReadKeyList.Hka_Bd.ulBetriebssekunden.key,
client.ReadKeyList.Hka_Bd.ulArbeitElektr.key,
client.ReadKeyList.Hka_Bd.UHka_Anf.usAnforderung.key,
client.ReadKeyList.Hka_Bd.bStoerung.key,
client.ReadKeyList.Hka_Bd.bWarnung.key
).then(result => {
//...
});
// OR
//fetchAll fetches all readable keys at once
client.fetchAll().then(console.log);
```
## References and useful links
#### API Documentation (in German)
- https://community.symcon.de/t/senertec-bhkw-glt-einbindung-ueber-lan-ethernet/26658
- **Official User Manual** (`.rar` Archive with a PDF): https://community.symcon.de/uploads/short-url/6LOE4M5F4zx6XNMeQGgZEAs7AiC.rar
- https://www.bhkw-forum.de/diskussion/thread/5923-dachs-ethernet-informationssammlung/
- https://wiki.my-gekko.com/de/media/einbindungsenertecdachsbhkwv4795pdf_original.pdf
- https://forum.iobroker.net/topic/33944/senertec-dachs-bhkw
#### Similar Projects
- Python Cloud API: https://github.com/Kleinrotti/py-senertec
© 2022-2024 Trickfilm400