Usage

Generic config and information

Default definition of platform in your configuration file:

ecodevices_rt2:
  - name: NameOfYourEcoRT2
    host: "_ADDRESS_IP_"
    port: _PORT_                  # Optional, default: 80
    api_key: "_API_KEY_"
    scan_interval: 15             # Optional, default: 15 (seconds)
    update_after_switch: 0.1        # Optional, default: 0 (seconds)
    devices:
      - name: Friendly Name Of Entity
        type: "_TYPE_"
        component: "_COMPONENT_"  # Optional
        icon: mdi:water-boiler    # Optional, or depending on the case: price_icon, instant_icon, index_icon, humidity_icon, temperature_icon, illuminance_icon
        device_class: "power"     # Optional
        unit_of_measurement: "W"  # Optional, or depending on the case: price_unit_of_measurement, instant_unit_of_measurement, index_unit_of_measurement, humidity_unit_of_measurement, temperature_unit_of_measurement, illuminance_unit_of_measurement

Parameter for a the integration ecodevices_rt2
Parameter	Description	Possible values
name (REQUIRED)	Friendly name of your integration.	Any text value
host (REQUIRED)	IP address or hostname where your GCE Ecodevices RT2 is reacheable	Any address / hostname
port	OPTIONAL Port associated with the host	Default: 80
api_key (REQUIRED)	_API_KEY_ defined on your GCE Ecodevices RT2	Any text value
scan_interval	OPTIONAL Time to wait between two updates	Any value in second. Default: 15s
update_after_switch	OPTIONAL Time to wait before update a switch/light/climate juste after a change	Any float value in second. Default: 0 ATTENTION, if the value is too low, you may have trouble with the API.
devices (REQUIRED)	List of device definition	See next table

Parameter for a device configuration
Parameter	Description	Possible values
name (REQUIRED)	Friendly name of your entity	Any text value
type (REQUIRED)	Type of device connected to your Ecodevice RT2	api, counter, digitalinput, enocean, post, relay, supplierindex, toroid, virtualoutput, x4fp, xthl
component	Type of some default Home Assistant integration	switch, sensor, climate, binary_sensor, light
icon	Icons used by Home Assistant icons	Any, some example: mdi:home, mdi:lightbulb, mdi:toggle-switch, etc.
device_class	Type of Home Assistant device_class	Any, some example: none, energy, humidity, illuminance, etc.
unit_of_measurement	Unit of mesurement (Home Assistant unit_of_measurement)	Any text value, some example: W, °C, kWh, lx, etc.
allow_zero	Only for sensors. If False, zero values are not returned and sensor appears as “Not available”. Default is True.	Boolean value (True / False).

Possibles values for device configuration
type	Default component	Possible component
api	sensor	sensor, switch, light
counter	sensor	sensor
digitalinput	binary_sensor	binary_sensor
enocean	sensor	sensor, switch, light
post	sensor	sensor
relay	switch	switch, light
supplierindex	sensor	sensor
toroid	sensor	sensor
virtualoutput	switch	switch, light
x4fp	climate	climate, switch
xthl	sensor	sensor

Remember you can edit some parameters of your sensors according to Home Assistant Customizing, e.g. changing the unit on specific sensor in file customize.yaml:

sensor.index_chauffe_eau_consumptionindex:
  unit_of_measurement: Wh

Advanced/API usage

To use ecodevices_rt2, you can directly use parameters from the GCE Ecodevices RT2 API (or PDF).

Parameters
component	Description	Parameters
sensor (DEFAULT)	Create a sensor which will call http://_ADDRESS_IP_:_PORT_/api/xdevices.json?key=_API_KEY_&api_get=api_get_value and get api_get_entry in the JSON response.	api_get: REQUIRED. api_get_value: REQUIRED api_get_entry: REQUIRED allow_zero: OPTIONAL True/False
switch (or light)	Create a switch (or light) which will: VALUE – To check the current value of the switch, it will call http://_ADDRESS_IP_:_PORT_/api/xdevices.json?key=_API_KEY_&api_get=api_get_value and get api_get_entry in the JSON response. ON – To change the current value of the switch to ON, it will call http://_ADDRESS_IP_:_PORT_/api/xdevices.json?key=_API_KEY_&api_on_get=api_on_get_value and it will check if the “status” in the JSON response is equal to “Success”. OFF – To change the current value of the switch to OFF, it will call http://_ADDRESS_IP_:_PORT_/api/xdevices.json?key=_API_KEY_&api_off_get=api_off_get_value and it will check if the “status” in the JSON response is equal to “Success”.	api_get: REQUIRED api_get_value: REQUIRED api_get_entry: REQUIRED api_on_get: REQUIRED api_on_get_value: REQUIRED api_off_get: REQUIRED api_off_get_value: REQUIRED

Example

ecodevices_rt2:
  - name: NameOfYourEcoRT2
    host: "_ADDRESS_IP_"
    api_key: "_API_KEY_"
    devices:
      - name: Elec Index HC
        type: "api"
        component: "sensor"
        api_get: "Index"
        api_get_value: "All"
        api_get_entry: "Index_TI1"
        device_class: "power"
        unit_of_measurement: "kWh"
        icon: "mdi:flash"

      - name: EnOcean Switch 1
        type: "api"
        component: "switch"
        api_get: "Get"
        api_get_value: "XENO"
        api_get_entry: "ENO ACTIONNEUR1"
        api_on_get: "SetEnoPC"
        api_on_get_value: "1"
        api_off_get: "ClearEnoPC"
        api_off_get_value: "1"

Counter

You can define a Counter (see from the GCE Ecodevices RT2 API (or PDF)).

Parameters
component	Description	Parameters
sensor (DEFAULT)	Create 2 sensor which represents a counter connected to the GCE Ecodevices RT2: Index of the counter Price of the counter	id: REQUIRED Number of the counter (between 1 and 12) allow_zero: OPTIONAL True/False index_unit_of_measurement: OPTIONAL, unit for Index sensor. Default: “Wh”. index_icon: OPTIONAL, icon for Index sensor. price_unit_of_measurement: OPTIONAL, unit for Price sensor. Default: currency defined in Home Assistant. price_icon: OPTIONAL, icon for Price sensor.

Example

ecodevices_rt2:
  - name: NameOfYourEcoRT2
    host: "IP_RT2"
    api_key: "API_KEY_RT2"
    devices:
      - name: Counter 1
        type: "counter"
        id: 1
        allow_zero: False
        price_unit_of_measurement: "USD" # Optional
        price_icon: mdi:account-cash # Optional
        index_unit_of_measurement: "kW" # Optional
        index_icon: mdi:transmission-tower # Optional

DigitalInput

You can define a DigitalInput (see from the GCE Ecodevices RT2 API (or PDF)).

Parameters
component	Description	Parameters
binary_sensor (DEFAULT)	Create a binary_sensor which represents a digitalinput connected to the GCE Ecodevices RT2	id: REQUIRED Number of the digitalinput (between 1 and 12) allow_zero: OPTIONAL True/False

Example

ecodevices_rt2:
  - name: NameOfYourEcoRT2
    host: "IP_RT2"
    api_key: "API_KEY_RT2"
    devices:
      - name: DigitalInput 1
        type: "digitalinput"
        id: 1

EnOcean Switch or Sensor

You can define a EnOcean Switch or Sensor (see from the GCE Ecodevices RT2 API (or PDF)).

Parameters
component	Description	Parameters
sensor (DEFAULT)	Create a sensor which represents a enocean analog sensor connected to the GCE Ecodevices RT2	id: REQUIRED Number of the enocean sensor (between 1 and 24) allow_zero: OPTIONAL True/False
switch	Create a switch which represents a enocean actuator connected to the GCE Ecodevices RT2	id: REQUIRED Number of the enocean actuator (between 1 and 24)
light	Create a light which represents a enocean actuator connected to the GCE Ecodevices RT2	id: REQUIRED Number of the enocean actuator (between 1 and 24)

Example

ecodevices_rt2:
  - name: NameOfYourEcoRT2
    host: "IP_RT2"
    api_key: "API_KEY_RT2"
    devices:
      - name: Bedroom temperature
        type: "enocean"           # Using default component `sensor`
        id: 1
        unit_of_measurement: "°C"
        icon: mdi:thermometer
      - name: EnOcean Switch 1
        type: "enocean"
        component: "switch"
        id: 1
      - name: EnOcean Switch 2 as Light
        type: "enocean"
        component: "light"
        id: 2

Post and Sub-Post

You can define a Post and Sub-post (see from the GCE Ecodevices RT2 API (or PDF)).

Parameters
component	Description	Parameters
sensor (DEFAULT)	Create 5 sensor which represents a post defined on the GCE Ecodevices RT2 Index of the Post/Subpost IndexDay of the Post/Subpost Price of the Post/Subpost PriceDay of the Post/Subpost Instant power of the Post/Subpost	id: REQUIRED Number of the post (between 1 and 8) subpost: OPTIONAL Number of the subpost of the post (between 1 and 8) allow_zero: OPTIONAL True/False index_unit_of_measurement: OPTIONAL, unit for Index and ÌndexDay sensors. Default: “kWh”. index_icon: OPTIONAL, icon for Index and ÌndexDay sensors. price_unit_of_measurement: OPTIONAL, unit for Price and PriceDay sensors. Default: currency defined in Home Assistant. price_icon: OPTIONAL, icon for Price and PriceDay sensors. instant_unit_of_measurement: OPTIONAL, unit for Instant sensor. Default: “W”. instant_icon: OPTIONAL, icon for Instant sensor.

Example

ecodevices_rt2:
  - name: NameOfYourEcoRT2
    host: "IP_RT2"
    api_key: "API_KEY_RT2"
    devices:
      - name: Post 1
        type: "post"
        id: 1
      - name: Subpost 2 of Post 1
        type: "post"
        id: 1
        subpost: 2

Relay

You can define a Relay (see from the GCE Ecodevices RT2 API (or PDF)).

Parameters
component	Description	Parameters
switch (DEFAULT)	Create a switch which represents a relay connected on the GCE Ecodevices RT2	id: REQUIRED Number of the post (between 1 and 8)
light	Create a light which represents a relay connected on the GCE Ecodevices RT2	id: REQUIRED Number of the post (between 1 and 8)

Example

ecodevices_rt2:
  - name: NameOfYourEcoRT2
    host: "IP_RT2"
    api_key: "API_KEY_RT2"
    devices:
      - name: Relay 1
        type: "relay"        # Using default component `sensor`
        id: 1
      - name: Relay 2 as Light
        type: "relay"
        component: "light"
        id: 2

SupplierIndex

You can define a SupplierIndex (see from the GCE Ecodevices RT2 API (or PDF)).

Parameters
component	Description	Parameters
sensor (DEFAULT)	Create 2 sensor which represent a SupplierIndex defined on the GCE Ecodevices RT2 Index of the Post/Subpost Price of the Post/Subpost	id: REQUIRED Number of the SupplierIndex (between 1 and 8) allow_zero: OPTIONAL True/False index_unit_of_measurement: OPTIONAL, unit for Index sensor. Default: “Wh”. index_icon: OPTIONAL, icon for Index sensor. price_unit_of_measurement: OPTIONAL, unit for Price sensor. Default: currency defined in Home Assistant. price_icon: OPTIONAL, icon for Price sensor.

Example

ecodevices_rt2:
  - name: NameOfYourEcoRT2
    host: "IP_RT2"
    api_key: "API_KEY_RT2"
    devices:
    - name: Supplier Index 1 (EDF Info)
      type: "supplierindex"
      id: 1
      price_unit_of_measurement: "EUR" # Optional
      price_icon: mdi:currency-btc # Optional
      index_unit_of_measurement: "kW" # Optional
      index_icon: mdi:transmission-tower # Optional

Toroid

You can define a Toroid (see from the GCE Ecodevices RT2 API (or PDF)).

Parameters
component	Description	Parameters
sensor (DEFAULT)	If id is between 1 and 4, create 4 sensor which represents a Toroid defined on the GCE Ecodevices RT2 ConsumptionIndex of the Toroid ConsumptionPrice of the Toroid ProductionIndex of the Toroid ProductionPrice of the Toroid Else (id>4), create 2 sensor which represents a Toroid defined on the GCE Ecodevices RT2 Index of the Toroid Price of the Toroid	id: REQUIRED Number of the Toroid (between 1 and 8) allow_zero: OPTIONAL True/False index_unit_of_measurement: OPTIONAL, unit for all Index sensors. Default: “Wh”. index_icon: OPTIONAL, icon for all Index sensors. price_unit_of_measurement: OPTIONAL, unit for all Price sensors. Default: currency defined in Home Assistant. price_icon: OPTIONAL, icon for all Price sensors.

Example

ecodevices_rt2:
  - name: NameOfYourEcoRT2
    host: "IP_RT2"
    api_key: "API_KEY_RT2"
    devices:
    - name: Toroid 1  # 2 sensors
      type: "toroid"
      id: 1
    - name: Toroid 5  # 2 sensors
      type: "toroid"
      id: 5

VirtualOutput

You can define a VirtualOutput (see from the GCE Ecodevices RT2 API (or PDF)).

Parameters
component	Description	Parameters
switch (DEFAULT)	Create a switch which represents a VirtualOutput connected on the GCE Ecodevices RT2	id: REQUIRED Number of the VirtualOutput (between 1 and 128)
light	Create a light which represents a VirtualOutput connected on the GCE Ecodevices RT2	id: REQUIRED Number of the VirtualOutput (between 1 and 128)

Example

ecodevices_rt2:
  - name: NameOfYourEcoRT2
    host: "IP_RT2"
    api_key: "API_KEY_RT2"
    devices:
    - name: Virtual Output 1
        type: "virtualoutput"           # Using default component `sensor`
        id: 1
    - name: Virtual Output 2 as Light
      type: "virtualoutput"
      component: "light"
      id: 2

X4FP (Heaters)

You can define a X4FP (see from the GCE Ecodevices RT2 API (or PDF)).

Parameters
component	Description	Parameters
climate (DEFAULT)	Create a climate which represents a X4FP connected on the GCE Ecodevices RT2	module: REQUIRED Number of the X4FP module (1 or 2) zone: REQUIRED Number of the X4FP zone on the seleted module (between 1 and 4. 0 if you want to control all zone of the module.)
switch	Create a switch which represents a X4FP connected on the GCE Ecodevices RT2	module: REQUIRED Number of the X4FP module (1 or 2) zone: REQUIRED Number of the X4FP zone on the seleted module (between 1 and 4. 0 if you want to control all zone of the module.)

Example

ecodevices_rt2:
  - name: NameOfYourEcoRT2
    host: "IP_RT2"
    api_key: "API_KEY_RT2"
    devices:
    - name: Heater Module 1 Zone 1
      type: "x4fp"
      component: "climate"      # Can be omitted since default value
      module: 1
      zone: 1
    - name: Heater Module 1 Zone 2 as Switch
      type: "x4fp"
      component: "switch"
      module: 1
      zone: 2

XTHL

You can define a XTHL (see from the GCE Ecodevices RT2 API (or PDF)).

Parameters
component	Description	Parameters
sensor (DEFAULT)	Create 3 sensor which represents a XTHL defined on the GCE Ecodevices RT2 Temperature of the XTHL Humidity of the XTHL Luminance of the XTHL	id: REQUIRED Number of the XTHL (between 1 and 2) allow_zero: OPTIONAL True/False temperature_unit_of_measurement: OPTIONAL, unit for Temperature sensor. Default: “°C”. temperature_icon: OPTIONAL, icon for Temperature sensor. humidity_unit_of_measurement: OPTIONAL, unit for Humidity sensor. Default: “%”. humidity_icon: OPTIONAL, icon for Humidity sensor. illuminance_unit_of_measurement: OPTIONAL, unit for Luminance sensor. Default: “lx”. illuminance_icon: OPTIONAL, icon for Luminance sensor.

Example

ecodevices_rt2:
  - name: NameOfYourEcoRT2
    host: "IP_RT2"
    api_key: "API_KEY_RT2"
    devices:
    - name: XHTL 1
      type: "xthl"
      id: 1
      illuminance_unit_of_measurement: "lux" # Optional
      illuminance_icon: mdi:sun-wireless-outline # Optional
      temperature_unit_of_measurement: "°F" # Optional
      temperature_icon: mdi:coolant-temperature # Optional
      humidity_unit_of_measurement: "/100" # Optional
      humidity_icon: mdi:cloud-percent # Optional