Skip to content

Commit

Permalink
Merge branch 'master' into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
marq24 committed Oct 5, 2023
2 parents a2af50d + 849a897 commit 2637342
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions DEVELOPER_DOCUMENTATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,33 @@
This document should give an overview regarding the used APIs and the possible data that can be queried.

## Data that can be accessed in the local network from a Senec V3 device
Basis for this documentation is the firmware Version 825.
Basis for this documentation is the firmware version 0826.

The following information are provided by the device. Since no open acceccible API documentation exists, the following description is an assumption.
- The following information can be accessed sending a post request with a JSON-Payload to https://[IP of the senec device]/lala.cgi
- As response a JSON String is returned
- Please note: Depending on the firmware version the Request has to be via http or https. (https starting with the firmware version 825)

### Logfile
The logfile of the device can be accessed via URL and shows a raw text file.
The URL has the following format: https://[IP of the device]/Log/[year]/[month]/[day].log
Example: https://192.168.1.115/Log/2023/09/08.log
The URL has the following format: `https://[IP of the device]//log/[year]/[month]/[day].log` (and __YES__ there are two
`/` behind the ip-address since v0826)

Example: https://192.168.1.115//log/2023/10/05.log

### VarMon & Chart
It is possible to get a list of all variables and their values of the device, even if Senec claimed that this data is
only accessible by themselves (since 0826) - the access is still possible for every owner without any kind of hacks.

### Request Example
| version | url |
|--------------|-----------------------------------------|
| before v0825 | `https://[IP of the device]/vars.html` |
| v0825 | `https://[IP of the device]/Vars.html` |
| v0826 | `https://[IP of the device]//vars.html` |

Example: https://192.168.1.115//vars.html

### lala.cgi Request Example
To gather data we have to send a POST-Request to the Senec device ("lala.cgi"), that has a JSON-String as payload.
Here an request example with all objects that can be requested. Many of the objects have sub-objects:
```
Expand Down Expand Up @@ -60,6 +75,7 @@ content-type: application/json
"FAN_SPEED":{}
}
```

### Response Example
The response returns a JSON-String for the requested object.
In this example the "ENERGY" was used.
Expand Down

0 comments on commit 2637342

Please sign in to comment.