Welcome to pyecodevices-rt2’s documentation!

pyecodevices-rt2 - Python GCE Ecodevices RT2

Get information from GCE Ecodevices RT2.

This work is originally developed for use with Home Assistant and the custom component ecodevices_rt2.

• Free software: MIT license

• Documentation: https://pyecodevices-rt2.readthedocs.io.

Features

• Connect to the API (see GCE Ecodevices RT2 API (or PDF)) and get any value:

# Example with indexes
from pyecodevices_rt2 import EcoDevicesRT2
ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")
ecodevices.get('Index','All') # Get all indexes as JSON
ecodevices.get('Index','All','Index_TI1') # Get specific value

• Define a simple object such as Counter, DigitalInput, EnOcean Switch or Sensor, Post and Sub-Post, Relay, SupplierIndex, Toroid, VirtualOutput, X4FP (Heaters), XTHL:

# Example with a Relay
from pyecodevices_rt2 import EcoDevicesRT2, Relay
ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")
# Relay number 1
test = Relay(ecodevices, 1)
print("Current status: %r" % test.status)
test.off() # Change relay to off
test.on() # Change relay to on
test.toggle() # Invert relay status
test.status = True # Change relay to on

• Play with cached variables. You can defined a maximum value (in milliseconds) during which you consider an API value do not need to be updated:

from pyecodevices_rt2 import EcoDevicesRT2

# Create the ecodevices object with a default "cached" value of 1s
ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey", cached_ms=1000)

print("# All Indexes")
print(ecodevices.get('Index','All')) # Call the API
print(ecodevices.get('Index','All')) # Do not call the API since the last value was retrieved less than 1s (1000ms) ago
print(ecodevices.get('Index','All',cached_ms=0)) # Force to call the API even if the last value was retrieved less than 1s (1000ms) ago

# For each property in other objects, you can call "get_PROPERTY(cached_ms=XX)"
# Example with Counter 1:
test = Counter(ecodevices, 1)
print("Current value: %d" % test.value) # Call the API
print("Current price: %d" % test.price) # Call the API
print("Current value: %d" % test.value) # Do not call the API since the last value was retrieved less than 1s (1000ms) ago
print("Current price: %d" % test.price) # Do not call the API since the last value was retrieved less than 1s (1000ms) ago
print("Current value: %d" % test.get_value()) # Do not call the API since the last value was retrieved less than 1s (1000ms) ago
print("Current price: %d" % test.get_price()) # Do not call the API since the last value was retrieved less than 1s (1000ms) ago
print("Current value: %d" % test.get_value(cached_ms=0)) # Force to call the API even if the last value was retrieved less than 1s (1000ms) ago
print("Current price: %d" % test.get_price(cached_ms=0)) # Force to call the API even if the last value was retrieved less than 1s (1000ms) ago
print("Current value: %d" % test.get_value(cached_ms=2000)) # Do not call the API if the last value was retrieved less than 2s (2000ms) ago
print("Current price: %d" % test.get_price(cached_ms=2000)) # Do not call the API if the last value was retrieved less than 2s (2000ms) ago

Credits

This work is inspired by the work of Aohzan.

This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

Installation

Stable release

To install pyecodevices-rt2, run this command in your terminal:

$ pip install pyecodevices-rt2

This is the preferred method to install pyecodevices-rt2, as it will always install the most recent stable release.

If you don’t have pip installed, this Python installation guide can guide you through the process.

From sources

The sources for pyecodevices-rt2 can be downloaded from the Github repo.

You can either clone the public repository:

$ git clone git://github.com/pcourbin/pyecodevices_rt2

Or download the tarball:

$ curl -OJL https://github.com/pcourbin/pyecodevices_rt2/tarball/master

Once you have a copy of the source, you can install it with:

$ python setup.py install

Usage

EcoDevicesRT2

For the API and parameters, see GCE Ecodevices RT2 API (or PDF).

Parameters:

- `host`: ip or hostname
- `port`: (default: 80)
- `apikey`: if authentication enabled on Ecodevices RT2
- `timeout`: (default: 3)
- `cached_ms`: (default: 0), maximum delay in milliseconds during which we consider the value do not need to be updated using the API.

Properties:

- `host`: the host
- `apikey`: the apikey
- `apiurl`: the default apiurl
- `cached_ms`: the value of the maximum cached value in milliseconds

Methods:

- `ping`: return true if the Ecodevices answer
- `get`: return json or part of json.

Using cached values

You can defined a maximum value (in milliseconds) during which you consider an API value do not need to be updated:

from pyecodevices_rt2 import EcoDevicesRT2

# Create the ecodevices object with a default "cached" of 1s
ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey", cached_ms=1000)

print("# All Indexes")
print(ecodevices.get('Index','All')) # Call the API
print(ecodevices.get('Index','All')) # Do not call the API since the last value was retrieved less than 1s (1000ms) ago
print(ecodevices.get('Index','All',cached_ms=0)) # Force to call the API even if the last value was retrieved less than 1s (1000ms) ago

# For each property in other objects, you can call "get_PROPERTY(cached_ms=XX)"
# Example with Counter 1:
test = Counter(ecodevices, 1)
print("Current value: %d" % test.value) # Call the API
print("Current price: %d" % test.price) # Call the API
print("Current value: %d" % test.value) # Do not call the API since the last value was retrieved less than 1s (1000ms) ago
print("Current price: %d" % test.price) # Do not call the API since the last value was retrieved less than 1s (1000ms) ago
print("Current value: %d" % test.get_value()) # Do not call the API since the last value was retrieved less than 1s (1000ms) ago
print("Current price: %d" % test.get_price()) # Do not call the API since the last value was retrieved less than 1s (1000ms) ago
print("Current value: %d" % test.get_value(cached_ms=0)) # Force to call the API even if the last value was retrieved less than 1s (1000ms) ago
print("Current price: %d" % test.get_price(cached_ms=0)) # Force to call the API even if the last value was retrieved less than 1s (1000ms) ago
print("Current value: %d" % test.get_value(cached_ms=2000)) # Do not call the API if the last value was retrieved less than 2s (2000ms) ago
print("Current price: %d" % test.get_price(cached_ms=2000)) # Do not call the API if the last value was retrieved less than 2s (2000ms) ago

# Force to get all values for all requests defined in ecodevices._cached (see consts.RT2_API_GET_LINK_CACHED to default requests cached)
ecodevices.get_all_cached()
print("Current value: %d" % test.value) # Do not call the API since the last value may be retrieved less than 1s (1000ms) ago

Advanced/API usage

To use pyecodevices-rt2 in a project, you can directly use parameters from the GCE Ecodevices RT2 API (or PDF):

from pyecodevices_rt2 import EcoDevicesRT2

ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")

print("# ping")
print(ecodevices.ping())
print("# Default API call")
print(ecodevices.apiurl)

# Indexes
print("# All Indexes")
print(ecodevices.get('Index','All'))
print("# Only Index 'Index_TI1'")
print(ecodevices.get('Index','All','Index_TI1'))

# Powers
print("# Actual power on 'POSTE5'")
print(ecodevices.get('Get','P','INSTANT_POSTE5'))

# EnOcean
print("# All Enocean")
print(ecodevices.get('Get','XENO'))
print("# Set Enocean1 and get status")
print(ecodevices.get('SetEnoPC','1','status'))
print("# Clear Enocean2 and get status")
print(ecodevices.get('ClearEnoPC','2','status'))

# Heaters / FP Modules
print("# Current state of all zones")
print(ecodevices.get('Get','FP'))
print("# Current state of First Zone of First FP module")
print(ecodevices.get('Get','FP', 'FP1 Zone 1'))
print("# Force First Zone of First FP module to be on 'Confort' mode and get status")
print(ecodevices.get('SetFP01','0', 'status'))

Counter

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

from pyecodevices_rt2 import EcoDevicesRT2, Counter

ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")
print("# ping")
print(ecodevices.ping())

# Counter number 1
test = Counter(ecodevices, 1)
print("Current value: %d" % test.value)
print("Current price: %d" % test.price)

test.value = 20 # Change the value of the counter to 20
test.add(5) # Add 5 to the counter
test.substrat(10) # Substract 10 to the counter

DigitalInput

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

from pyecodevices_rt2 import EcoDevicesRT2, DigitalInput

ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")
print("# ping")
print(ecodevices.ping())

# DigitalInput number 1
test = DigitalInput(ecodevices, 1)
print("Current status: %r" % test.status)

EnOcean Switch or Sensor

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

from pyecodevices_rt2 import EcoDevicesRT2, EnOceanSensor, EnOceanSwitch

ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")
print("# ping")
print(ecodevices.ping())

# EnOceanSensor number 1
test = EnOceanSensor(ecodevices, 1)
print("Current value: %f" % test.value)

# EnOceanSwitch number 1
test = EnOceanSwitch(ecodevices, 1)
print("Current status: %r" % test.status)
test.off() # Change switch to off
test.on() # Change switch to on
test.toggle() # Invert switch status
test.status = True # Change switch to on

Post and Sub-Post

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

from pyecodevices_rt2 import EcoDevicesRT2, Post

ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")
print("# ping")
print(ecodevices.ping())

# Post number 1
test = Post(ecodevices, 1)
print("Index: %f" % test.index)
print("Price: %f" % test.price)
print("Index of the day: %f" % test.index_day)
print("Price of the day: %f" % test.price_day)
print("Instant power: %f" % test.instant)

# Sub-post number 2 of Post 1
test = Post(ecodevices, 1, 2)
print("Index: %f" % test.index)
print("Price: %f" % test.price)
print("Index of the day: %f" % test.index_day)
print("Price of the day: %f" % test.price_day)
print("Instant power: %f" % test.instant)

Relay

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

from pyecodevices_rt2 import EcoDevicesRT2, Relay

ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")
print("# ping")
print(ecodevices.ping())

# Relay number 1
test = Relay(ecodevices, 1)
print("Current status: %r" % test.status)
test.off() # Change relay to off
test.on() # Change relay to on
test.toggle() # Invert relay status
test.status = True # Change relay to on

SupplierIndex

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

from pyecodevices_rt2 import EcoDevicesRT2, SupplierIndex

ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")
print("# ping")
print(ecodevices.ping())

# SupplierIndex number 1
test = SupplierIndex(ecodevices, 1)
print("Index: %f" % test.value)
print("Price: %f" % test.price)

Toroid

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

from pyecodevices_rt2 import EcoDevicesRT2, Toroid

ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")
print("# ping")
print(ecodevices.ping())

# Toroid number 1
test = Toroid(ecodevices, 1)
print("Value: %f" % test.value)
print("Price: %f" % test.price)

VirtualOutput

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

from pyecodevices_rt2 import EcoDevicesRT2, VirtualOutput

ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")
print("# ping")
print(ecodevices.ping())

# VirtualOutput number 1
test = VirtualOutput(ecodevices, 1)
print("Current status: %r" % test.status)
test.off() # Change virtualoutput to off
test.on() # Change virtualoutput to on
test.toggle() # Invert virtualoutput status
test.status = True # Change virtualoutput to on

X4FP (Heaters)

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

from pyecodevices_rt2 import EcoDevicesRT2, X4FP

ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")
print("# ping")
print(ecodevices.ping())

# X4FP of Module 1, Zone 2
test = X4FP(ecodevices, 1, 2)
print("Current mode: %d" % test.mode)
test.mode = 1 # Change mode to `Eco`

List of Heater/X4FP mode values

Mode	State (EN)	Etat (FR)
-1	UNKNOWN (or module not present)	UNKNOWN (ou module non présent)
0	Confort	Confort
1	Eco	Eco
2	Frost free	Hors Gel
3	Stop	Arret
4	Confort -1	Confort -1
5	Confort -2	Confort -2

XTHL

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

from pyecodevices_rt2 import EcoDevicesRT2, XTHL

ecodevices = EcoDevicesRT2('192.168.0.20','80',"mysuperapikey")
print("# ping")
print(ecodevices.ping())

# XTHL number 1
test = XTHL(ecodevices, 1)
print("Temperature: %f" % test.temperature)
print("Humidity: %f" % test.humidity)
print("Luminosity: %f" % test.luminosity)

pyecodevices_rt2

pyecodevices_rt2 package

Submodules

pyecodevices_rt2.abstractsensor module

class pyecodevices_rt2.abstractsensor.AbstractSensor(ecort2: EcoDevicesRT2, id: int, get_link: str, get_entry: str)

Bases: object

Class representing an AbstractSensor

get_value(cached_ms: Optional[int] = None) → float

Return the current AbstractSensor status.

property value: float

pyecodevices_rt2.abstractswitch module

class pyecodevices_rt2.abstractswitch.AbstractSwitch(ecort2: EcoDevicesRT2, id: int, get_link: str, get_entry: str, on_link: str, off_link: str, toggle_link: str)

Bases: object

Class representing an AbstractSwitch

get_status(cached_ms: Optional[int] = None) → bool

Return the current AbstractSwitch status.

off() → bool

Turn off a AbstractSwitch.

on() → bool

Turn on a the AbstractSwitch.

property status: bool

toggle() → bool

Toggle a AbstractSwitch.

pyecodevices_rt2.cli module

pyecodevices_rt2.const module

pyecodevices_rt2.counter module

class pyecodevices_rt2.counter.Counter(ecort2: EcoDevicesRT2, id: int)

Bases: object

Class representing the Counter

add(value: int) → bool

Add a value to the current Counter value.

get_price(cached_ms: Optional[int] = None) → float

Return the price of counter.

get_value(cached_ms: Optional[int] = None) → int

Return the current Counter value.

property price: float

substrat(value: int) → bool

Substract a value to the current Counter value.

property value: int

pyecodevices_rt2.digitalinput module

class pyecodevices_rt2.digitalinput.DigitalInput(ecort2: EcoDevicesRT2, id: int)

Bases: object

Class representing the DigitalInput

get_status(cached_ms: Optional[int] = None) → bool

Return the current DigitalInput status.

property status: bool

pyecodevices_rt2.ecodevices_rt2 module

class pyecodevices_rt2.ecodevices_rt2.EcoDevicesRT2(host: str, port: int = 80, apikey: str = '', timeout: int = 10, cached_ms: int = 0)

Bases: object

Class representing the Ecodevices RT2 and its API

property apikey

Return the apikey.

property apiurl

Return the default apiurl.

property cached_ms

Return the maximum cached value in milliseconds.

get(command, command_value=None, command_entry=None, cached_ms: Optional[int] = None)

Get value from api : http://{host}:{port}/api/xdevices.json?key={apikey}&{command}={command_value}, then get value {command_entry} in JSON response.

get_all_cached()

property host

Return the hostname.

ping() → bool

pyecodevices_rt2.enocean module

class pyecodevices_rt2.enocean.EnOceanSensor(ecort2: EcoDevicesRT2, id: int)

Bases: AbstractSensor

Class representing the EnOceanSensor

class pyecodevices_rt2.enocean.EnOceanSwitch(ecort2: EcoDevicesRT2, id: int)

Bases: AbstractSwitch

Class representing the EnOceanSwitch

pyecodevices_rt2.exceptions module

Exceptions for Ecodevices RT2.

exception pyecodevices_rt2.exceptions.EcoDevicesRT2ConnectError

Bases: Exception

Exception to indicate an error in connection.

exception pyecodevices_rt2.exceptions.EcoDevicesRT2RequestError

Bases: Exception

Exception to indicate an error with an API request.

pyecodevices_rt2.post module

class pyecodevices_rt2.post.Post(ecort2: EcoDevicesRT2, id_post: int, id_subpost: Optional[int] = None)

Bases: object

Class representing the Post or Sub-Post

get_index(cached_ms: Optional[int] = None) → float

Return the index of post/subpost.

get_index_day(cached_ms: Optional[int] = None) → float

Return the index of the current day of post/subpost.

get_instant(cached_ms: Optional[int] = None) → float

Return the instant power of post/subpost.

get_price(cached_ms: Optional[int] = None) → float

Return the price of post/subpost.

get_price_day(cached_ms: Optional[int] = None) → float

Return the price of the current day of post/subpost.

property index: float

property index_day: float

property instant: float

property price: float

property price_day: float

pyecodevices_rt2.relay module

class pyecodevices_rt2.relay.Relay(ecort2: EcoDevicesRT2, id: int)

Bases: AbstractSwitch

Class representing the Relay

pyecodevices_rt2.supplierindex module

class pyecodevices_rt2.supplierindex.SupplierIndex(ecort2: EcoDevicesRT2, id: int)

Bases: AbstractSensor

Class representing the SupplierIndex

get_price(cached_ms: Optional[int] = None) → float

Return the price of supplier index.

property price: float

pyecodevices_rt2.toroid module

class pyecodevices_rt2.toroid.Toroid(ecort2: EcoDevicesRT2, id: int)

Bases: object

Class representing the Toroid

get_price(cached_ms: Optional[int] = None) → float

Return the price of toroid.

get_value(cached_ms: Optional[int] = None) → float

Return the index of toroid.

property price: float

property value: float

pyecodevices_rt2.virtualoutput module

class pyecodevices_rt2.virtualoutput.VirtualOutput(ecort2: EcoDevicesRT2, id: int)

Bases: AbstractSwitch

Class representing the VirtualOutput

pyecodevices_rt2.x4fp module

class pyecodevices_rt2.x4fp.X4FP(ecort2: EcoDevicesRT2, module_id: int, zone_id: int)

Bases: object

Class representing the X4FP

get_mode(cached_ms: Optional[int] = None) → int

Return the current X4FP mode.

property mode: int

pyecodevices_rt2.xthl module

class pyecodevices_rt2.xthl.XTHL(ecort2: EcoDevicesRT2, id: int)

Bases: object

Class representing the XTHL

get_humidity(cached_ms: Optional[int] = None) → bool

Return the current XTHL humidity.

get_luminosity(cached_ms: Optional[int] = None) → bool

Return the current XTHL luminosity.

get_temperature(cached_ms: Optional[int] = None) → bool

Return the current XTHL temperature.

property humidity: bool

property luminosity: bool

property temperature: bool

Module contents

Get information from GCE Ecodevices RT2.

class pyecodevices_rt2.AbstractSensor(ecort2: EcoDevicesRT2, id: int, get_link: str, get_entry: str)

Bases: object

Class representing an AbstractSensor

get_value(cached_ms: Optional[int] = None) → float

Return the current AbstractSensor status.

property value: float

class pyecodevices_rt2.AbstractSwitch(ecort2: EcoDevicesRT2, id: int, get_link: str, get_entry: str, on_link: str, off_link: str, toggle_link: str)

Bases: object

Class representing an AbstractSwitch

get_status(cached_ms: Optional[int] = None) → bool

Return the current AbstractSwitch status.

off() → bool

Turn off a AbstractSwitch.

on() → bool

Turn on a the AbstractSwitch.

property status: bool

toggle() → bool

Toggle a AbstractSwitch.

class pyecodevices_rt2.Counter(ecort2: EcoDevicesRT2, id: int)

Bases: object

Class representing the Counter

add(value: int) → bool

Add a value to the current Counter value.

get_price(cached_ms: Optional[int] = None) → float

Return the price of counter.

get_value(cached_ms: Optional[int] = None) → int

Return the current Counter value.

property price: float

substrat(value: int) → bool

Substract a value to the current Counter value.

property value: int

class pyecodevices_rt2.DigitalInput(ecort2: EcoDevicesRT2, id: int)

Bases: object

Class representing the DigitalInput

get_status(cached_ms: Optional[int] = None) → bool

Return the current DigitalInput status.

property status: bool

class pyecodevices_rt2.EcoDevicesRT2(host: str, port: int = 80, apikey: str = '', timeout: int = 10, cached_ms: int = 0)

Bases: object

Class representing the Ecodevices RT2 and its API

property apikey

Return the apikey.

property apiurl

Return the default apiurl.

property cached_ms

Return the maximum cached value in milliseconds.

get(command, command_value=None, command_entry=None, cached_ms: Optional[int] = None)

Get value from api : http://{host}:{port}/api/xdevices.json?key={apikey}&{command}={command_value}, then get value {command_entry} in JSON response.

get_all_cached()

property host

Return the hostname.

ping() → bool

class pyecodevices_rt2.EnOceanSensor(ecort2: EcoDevicesRT2, id: int)

Bases: AbstractSensor

Class representing the EnOceanSensor

class pyecodevices_rt2.EnOceanSwitch(ecort2: EcoDevicesRT2, id: int)

Bases: AbstractSwitch

Class representing the EnOceanSwitch

class pyecodevices_rt2.Post(ecort2: EcoDevicesRT2, id_post: int, id_subpost: Optional[int] = None)

Bases: object

Class representing the Post or Sub-Post

get_index(cached_ms: Optional[int] = None) → float

Return the index of post/subpost.

get_index_day(cached_ms: Optional[int] = None) → float

Return the index of the current day of post/subpost.

get_instant(cached_ms: Optional[int] = None) → float

Return the instant power of post/subpost.

get_price(cached_ms: Optional[int] = None) → float

Return the price of post/subpost.

get_price_day(cached_ms: Optional[int] = None) → float

Return the price of the current day of post/subpost.

property index: float

property index_day: float

property instant: float

property price: float

property price_day: float

class pyecodevices_rt2.Relay(ecort2: EcoDevicesRT2, id: int)

Bases: AbstractSwitch

Class representing the Relay

class pyecodevices_rt2.SupplierIndex(ecort2: EcoDevicesRT2, id: int)

Bases: AbstractSensor

Class representing the SupplierIndex

get_price(cached_ms: Optional[int] = None) → float

Return the price of supplier index.

property price: float

class pyecodevices_rt2.Toroid(ecort2: EcoDevicesRT2, id: int)

Bases: object

Class representing the Toroid

get_price(cached_ms: Optional[int] = None) → float

Return the price of toroid.

get_value(cached_ms: Optional[int] = None) → float

Return the index of toroid.

property price: float

property value: float

class pyecodevices_rt2.VirtualOutput(ecort2: EcoDevicesRT2, id: int)

Bases: AbstractSwitch

Class representing the VirtualOutput

class pyecodevices_rt2.X4FP(ecort2: EcoDevicesRT2, module_id: int, zone_id: int)

Bases: object

Class representing the X4FP

get_mode(cached_ms: Optional[int] = None) → int

Return the current X4FP mode.

property mode: int

class pyecodevices_rt2.XTHL(ecort2: EcoDevicesRT2, id: int)

Bases: object

Class representing the XTHL

get_humidity(cached_ms: Optional[int] = None) → bool

Return the current XTHL humidity.

get_luminosity(cached_ms: Optional[int] = None) → bool

Return the current XTHL luminosity.

get_temperature(cached_ms: Optional[int] = None) → bool

Return the current XTHL temperature.

property humidity: bool

property luminosity: bool

property temperature: bool

Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/pcourbin/pyecodevices_rt2/issues.

If you are reporting a bug, please include:

• Your operating system name and version.

• Any details about your local setup that might be helpful in troubleshooting.

• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with “bug” and “help wanted” is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with “enhancement” and “help wanted” is open to whoever wants to implement it.

Write Documentation

pyecodevices-rt2 could always use more documentation, whether as part of the official pyecodevices-rt2 docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/pcourbin/pyecodevices_rt2/issues.

If you are proposing a feature:

• Explain in detail how it would work.

• Keep the scope as narrow as possible, to make it easier to implement.

• Remember that this is a volunteer-driven project, and that contributions are welcome :)

Get Started!

Ready to contribute? Here’s how to set up pyecodevices_rt2 for local development.

1. Fork the pyecodevices_rt2 repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/pyecodevices_rt2.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv pyecodevices_rt2
   $ cd pyecodevices_rt2/
   $ python setup.py develop
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 pyecodevices_rt2 tests
   $ python setup.py test or pytest
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.

2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.

3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check https://travis-ci.com/pcourbin/pyecodevices_rt2/pull_requests and make sure that the tests pass for all supported Python versions.

Tips

To run a subset of tests:

$ pytest tests.test_pyecodevices_rt2

Deploying

A reminder for the maintainers on how to deploy. Make sure all your changes are committed (including an entry in HISTORY.rst). Then run:

$ bump2version patch # possible: major / minor / patch
$ git push
$ git push --tags

Travis will then deploy to PyPI if tests pass.

Credits

Development Lead

• Pierre COURBIN <pierre.courbin@gmail.com>

Contributors

None yet. Why not be the first?

History

1.3.1 (2022-08-07)

• Add option with cached_ms<0 to force use the cache, or return None

1.3.0 (2022-08-07)

• Update Toroid API, using new EcoRT2 version 3.00.02

1.2.1 (2021-05-15)

• Add “get_all_cached” function to call all resquests to get a cached value.

1.2.0 (2021-05-14)

• Add “cached” possibilities to reduce the number of call to the API.

• The cached possibilities can be defined directly to the ecodevices_rt2 object (applicable to each call), or to a specific call on a property.

1.1.0 (2021-04-17)

• Add classes such as Counter, DigitalInput, EnOcean Switch or Sensor, Post and Sub-Post, Relay, SupplierIndex, Toroid, VirtualOutput, X4FP (Heaters), XTHL for ease of use

• Add tests to cover majority of code

• Add full examples in documentation

1.0.1 (2021-04-12)

• Update package with Cookiecutter and the audreyr/cookiecutter-pypackage project template.

1.0.0 (2021-04-08)

• First release on PyPI.

Indices and tables

• Index

• Module Index

• Search Page