Zipato

Zipato

This library provides access to various data from the Zipato home control unit. The data properties are based on the online specification found at (https://my.zipato.com/zipato-web/api/).

The Zipatile from Zipato is a complete Z-Wave based home control system in the form of a single device. Featuring a large number of built-in sensors and hardware modules, ZipaTile replaces numerous home devices such as a security system, thermostat, automation controller, IP camera, alarm siren or intercom.

Zipato REST Web Service API

The REST Web Service of the Zipato home control unit provides access to various data. The library supports a subset of the data items available via the Zipato Web API:

• Alarm
• Announcements
• Attributes
• Extended Attributes
• Values
• Bindings
• Brands
• Cameras
• Clusters
• Cluster Endpoints
• Contacts
• Devices
• Endpoints
• Groups
• Networks
• ExNetworks
• Rooms
• Rules
• Scenes
• Schedules
• Thermostats
• Virtual Endpoints
• Box

Additional detailed information can be obtained for the following data items.

• Alarm
• Attributes
• Bindings
• Brands
• Cameras
• Clusters
• Cluster Endpoints
• Devices
• Endpoints
• Groups
• Networks
• Rules
• Scenes
• Schedules
• Thermostats
• Virtual Endpoints
• Box

Authentication

The Zipato web service requires a two step login procedure.

1. call to local init (get / parse "jsessionid" and "nonce")

2. calculate the token (SHA-1) using the nonce and the user password.

3. complete login using the user name and token.

The HTTP header has to include the JSESSIONID for each call to the zipabox.

Zipato Class

The Zipato class implements all communication routines to read (and write) the data values from the Zipato Web Service. The only data needed to instanciate a Zipato class instance are:

• A logger
• The user name
• The user password

The Zipato class provides simple Read() and Write() methods to update the data values. Additional property helper functions allow to read properties or get property values.

Note that some of the access methods allow for various parameters to specify the returned data. The extended information methods default to a complete data set, and the standard data read methods return only the minimal information necessary. Typically most of the data have to be retrieved only once (static configuration values), and only attribute values are monitored (or controlled) by an application.

ZipatoIoT

The ZipatoIoT application, a Windows 10 IoT core background application, runs on a Raspberry PI. The application uses the respective REST web services to update several virtual meters on the Zipatile home control.

The virtual meters are:

• EM300LR
• ETAPU11
• Fronius
• HomeData
• KWLEC200
• Netatmo
• Wallbox

All virtual meters support up to 16 numeric values.

EM300LR

Value	Data	Units
Value1	Frequency	Hz
Value2	Power+	kW
Value3	Power+ L1	kW
Value4	Power+ L2	kW
Value5	Power+ L3	kW
Value6	Power-	kW
Value7	Power- L1	kW
Value8	Power- L2	kW
Value9	Power- L3	kW
Value10	Current L1	A
Value11	Current L2	A
Value12	Current L3	A
Value13	Voltage L1	V
Value14	Voltage L2	V
Value15	Voltage L3	V
Value16	Power Factor	-

ETAPU11

Value	Data	Units
Value1	Boiler Pressure	bar
Value2	Boiler Temperature	°C
Value3	Hotwater Temperature	°C
Value4	Heating Temperature	°C
Value5	Room Temperature	°C
Value6	Boiler Target	°C
Value7	Boiler Bottom	°C
Value8	Fluegas Temperature	°C
Value9	Draught Fan Speed	rpm
Value10	Residual O2	%
Value11	Room Target	°C
Value12	Flow Temperature	°C
Value13	Bin Content	kg
Value14	Stock Content	kg
Value15	Hotwater Target	°C
Value16	Outside Temperature	°C

Fronius

Value	Data	Units
Value1	Voltage DC	V
Value2	Current DC	A
Value3	Voltage AC	V
Value4	Current AC	A
Value5	Power AC	W
Value6	Daily Energy	Wh
Value7	Yearly Energy	Wh
Value8	Current L1	A
Value9	Current L2	A
Value10	Current L3	A
Value11	Voltage L1N	V
Value12	Voltage L2N	V
Value13	Voltage L3N	V
Value14	value14
Value15	value15
Value16	value16

HomeData

Value	Data	Units
Value1	Load	kW
Value2	Demand	kW
Value3	Generation	kW
Value4	Surplus	kW
Value5	Load L1	kW
Value6	Demand L1	kW
Value7	Generation L1	kW
Value8	Surplus L1	kW
Value9	Load L2	kW
Value10	Demand L2	kW
Value11	Generation L2	kW
Value12	Surplus L2	kW
Value13	Load L3	kW
Value14	Demand L3	kW
Value15	Generation L3	kW
Value16	Surplus L3	kW

KWLEC200

Value	Data	Units
Value1	Temperature Outdoor	°C
Value2	Temperature Exhaust	°C
Value3	Temperature Extract	°C
Value4	Temperature Supply	°C
Value5	Ventilation Level
Value6	Supply Fan Speed	rpm
Value7	Exhaust Fan Speed	rpm
Value8	TemperatureChannel	°C
Value9	value9 (not used)
Value10	value10 (not used)
Value11	value11 (not used)
Value12	value12 (not used)
Value13	value13 (not used)
Value14	value14 (not used)
Value15	value15 (not used)
Value16	value16 (not used)

Netatmo

Outdoor

Value	Data	Units
Value1	Temperature	°C
Value2	Pressure	mbar
Value3	Humidity	%
Value4	Min. Temperature	°C
Value5	Max. Temperature	°C
Value6	Rain	mm/h
Value7	Sum Rain 1h	mm/h
Value8	Sum Rain 24h	mm/h
Value9	Wind Strength	km/h
Value10	Wind Angle	°
Value11	Gust Strength	km/h
Value12	Gust Angle	°
Value13	Max. Wind Strength	km/h
Value14	Max. Wind Angle	°
Value15	value15 (not used)
Value16	value16 (not used)

Indoor

Value	Data	Units
Value1	Temperature Main	°C
Value2	Humidity Main	%
Value3	Noise	dB
Value4	CO2 Main	ppm
Value5	Temperature Module 1	°C
Value6	Humidity Module 1	%
Value7	CO2 Module 1	ppm
Value8	Temperature Module 2	°C
Value9	Humidity Module 2	%
Value10	CO2 Module 2	ppm
Value11	Temperature Module 3	°C
Value12	Humidity Module 3	%
Value13	CO2 Module 3	ppm
Value14	value14 (not used)
Value15	value15 (not used)
Value16	value16 (not used)

Wallbox

Value	Data	Units
Value1	Charging State
Value2	Power	kW
Value3	Current L1	A
Value4	Current L2	A
Value5	Current L3	A
Value6	Voltage L1	V
Value7	Voltage L2	V
Value8	Voltage L3	V
Value9	Power Factor	%
Value10	Present Energy	kWh
Value11	Total Energy	kWh
Value12	value12
Value13	value13
Value14	value14
Value15	value15
Value16	value16