xs1-api-client

What’s Changed

🚀 Features and ✨ Enhancements

• SDIST release improvements (#6) by @markusressel

What’s Changed

🐛 Bugfixes

• Bugfix/#1 assignment changes (#4) by @markusressel (thx to @fti7)
• Added method to get actuator/sensor by number

Breaking Changes:
This release changed a couple of parameter names, since the word id was wrongly used instead of number.
If you used named parameters please update them:

OLD: get_config_actuator(actuator_id=1)
NEW: get_config_actuator(number=1)

OLD: set_config_actuator(actuator_id=1, configuration)
NEW: set_config_actuator(number=1, configuration)

OLD: get_config_sensor(sensor_id=1)
NEW: get_config_sensor(number=1)

OLD: set_config_sensor(sensor_id=1, configuration)
NEW: set_config_sensor(number=1, configuration)

and a couple more...

• don't reuse HTTPAdapter as it seems to cause problems with asyncio

• fixed request session never getting closed
• small documentation fixes

• readme prettified

• a beautiful pypi release

• custom port parameter
• HTTPS support

• fixed "disabled" comparison
• improved parameter processing
  • parameter keys and values can now be of any type
  • if a key is defined as a ApiConstant as well as some other type (so it is ambiguous) the ApiConstant value will always take priority
• added ApiConstant Enum base class that all other Enums inherit from
• added eq method for ApiConstant
  • ApiConstants and strings can now be easily compared using the "==" operator
  • added test for ApiConstant eq method
• added api method for querying currently set host, user & password
• only update config info at init when a host is passed in
• refactored send_request method for better testability
• added many tests with mocked api responses taken from my own gateway
• added "host is None" check before trying to send a request
• added some missing ApiConstants like HC1 and HC2
• small documentation fixes
• code cleanup

• ActuatorType comparison fix
• pypi module fix

• added failure tolerance when sending requests
  • Requests will now be sent up to 5 times with an increasing backoff time between the retries
• test fixes
• build script improvements

Breaking changes:

• removed python 3.3 support, this library is now python 3.4+
• removed global host/user/pw configuration mechanism for much cleaner code
• api_constants now uses Enums instead of simple variables, strings can still be used though

Other changes:

• added many api methods:
  • retrieve main configuration
  • retrieve a list of compatible systems
  • retrieve a list of available functions
  • retrieve compatible types of actuators and sensors
  • retrieve a single actuator/sensor by id
  • retrieve and set the current configuration of actuators and sensors
  • set the name of a device on the xs1
  • additional methods for finding functions within an actuator by id or type
• added "enabled" parameter to "get_all_*" methods to easily be able to filter disabled devices
• improved error handling
• added __str__ overrides for easier printing of objects
• improved type documentation
• refactored base classes to __init__.py
• added Travis CI with build status in readme
• added codebeat
• added simple test
• added examples

• fix to support python 3.4