First project plan

First project plan

contacting sensors and actors

The goal would be to use the API of the EzControl XS1 device to log all sensor and actor activities when they are actually happening. The subscription api will help a lot to make that step.

This goal is achieved when there's a simple application that connects to a specific XS1 and logs all the sensor and actor data to disk.

retrieving the configuration and compatibility checks

The goal is to retrieve as much status and configuration information as possible from a XS1. This information would later be used by hacs itself for example in a user interface. Furthermore the complete sensor and actor configuration shall be retrieved and validated. It would be great to give each sensor configuration a specific ID depending on the sensors unique configuration points (except name and status) - so that sensors that got renamed or moved in the XS1 configuration would be associated correctly even if those out-of-hacs configuration changes were made on the fly. That would allow maximum flexibility towards configuration changes.

Additionally hacs should check for compatibility. In the future there will be new firmware versions and new API versions for the EzControl XS1. Therefore hacs needs to be aware which version of the API it's currently dealing with.

This goal is achieved when the data logging application from the previous goal was extended with an configuration and compatibility managing class. The achievement is unlocked when the user can do changes in the XS1 configuration tool like re-order the sensors or define duplicate sensors and the data logging application keeps track of that changes after a restart or when new sensors are seen.