✎ en:hems:universe:api []

You've loaded an old revision of the document! If you save it, you will create a new version with this data.

===== Application Programming Interface (API) =====

==== Direct loads control ====

| ''load_set[i]''   | bit | R/W | Managed load state; 0=off, 1=on; i = 10..17 |
| ''analog_out[i]'' | int | R/W | Analog output value in % i = 10..13         |

==== Timetable ====

|< 70% 25% 3% 3% >|
| ''timetable_cloud_once[i]''            |  bit  |  RO  | Enabled cloud optimization for "once" actions; 0=disabled, 1=enabled; i=0..7                |
| ''timetable_cloud_recurring[i]''       |  bit  |  RO  | Enabled cloud optimization for "recurring" actions; 0=disabled, 1=enabled; i=0..7           |
| ''timetable_analog_optimization[i]''   |  bit  |  RO  | Enabled cloud optimization for analog timetable; 0=disabled, 1=enabled; i=0..3              |

|< 70% 25% 3% 3% >|
| ''optimization_index[i]''              |  int  |  RW  | Timetable optimization index (0=broadcast = all timetables); i=0..50                                 |
| ''optimization_start[i]''              |  int  |  RW  | Timetable optimization start time; hhmmw; hh=hour, mm=minute, w=weekday(1=monday); i=0..50           |
| ''optimization_time[i]''               |  int  |  RW  | Timetable optimization period in min; i=0..50                                                        |
| ''optimization_command[i]''            |  int  |  RW  | Timetable optimization command, auto set to 0 after being processed  - see following table; i=0..50  | 
| ''optimization_value[i]''              |  int  |  RW  | Timetable optimization value , depends of ''optimization_command'' - see following table; i=0..50    |

<wrap hi> Variable ''optimization_command'' triggers timetable manipulation process so make sure to set all other variables before. </wrap>

|< 70% 3% 47% 3% >|
|       ''optimization_command''           ||        ''optimization_value''                    ||
|  1  | **managed load once actions**       |   0       | Set **OFF**                           |
| ::: | :::                                 |   1       | Set **ON**                            |
| ::: | :::                                 |  -1       | **Delete**                            |
|  2  | **managed load recurring actions**  |   0       | Set **OFF**                           |
| ::: | :::                                 |   1       | Set **ON**                            |
| ::: | :::                                 |  -1       | **Delete**                            |
|  3  | **tariff timetable**                |   0       | Set **LO**                            |
| ::: | :::                                 |   1       | Set **HI**                            |
| ::: | :::                                 |   2       | Set **DYNAMIC**                       |
| ::: | :::                                 |  -1       | **Delete** Dynamic                    |
|  4  | **set mask**                        |   0..0xFF | Set once **on/off** as per bit value  |
|  5  | **analog timetable**                |   0..100  | Set **0..100%**                       |
| ::: | :::                                 |  -1       | **Delete** Analog                     |
|  6  | **battery setpoint**                |   -100..0 | Set discharge **0..100%**             |
| ::: | :::                                 |  0..100   | Set charge **0..100%**                |
| ::: | :::                                 |  -31768   | Set **auto**                          |

Edit summary

Note: By editing this page you agree to license your content under the following license: CC Attribution-Share Alike 4.0 International