v0.4.0

[sdwilsh]

New Features

• A context manager has been added to easily make API calls in a safe way when using asyncio
• A number of API helper methods have been added to make it easy for some important, common operations (support to roll your own still exists!)
  • get_serial_number to get the serial of the connected GEM
  • set_date_and_time to set the date and time on the connected GEM
  • set_packet_format to set the primary packet format (COM1) on the connected GEM
  • set_packet_send_interval to set the frequency in which packets are sent from the connected GEM
  • set_secondary_packet_format to set the secondary packet format (COM1) on the connected GEM
  • synchronize_time to synchronize the time on the connected GEM with the local device

Fixes

• end_api_request was not callable immediately after begin_api_request, which would result in even more brokenness if an exception occurred.

What's Changed

• Version bump to 0.4.0a0 by @sdwilsh in Version bump to 0.4.0a0 #23
• Provide a better message when the state is not what is expected by @sdwilsh in Provide a better message when the state is not what is expected #25
• end_api_request should be callable immediately after begin_api_request by @sdwilsh in end_api_request should be callable immediately after begin_api_request #27
• Provide a context manager and helper method for API Calls by @sdwilsh in Provide a context manager and helper method for API Calls #26
• Add ability to set the time on a GEM by @sdwilsh in Add ability to set the time on a GEM #28
• Update documentation to reflect new ways to call API by @sdwilsh in Update documentation to reflect new ways to call API #30
• Add tests and documentation for API methods by @sdwilsh in Add tests and documentation for API methods #31
• Add a number of APIs to set things on the GEM by @sdwilsh in Add a number of APIs to set things on the GEM #29
• Bump black from 21.9b0 to 21.10b0 by @dependabot in Bump black from 21.9b0 to 21.10b0 #34
• Bump flake8 from 3.9.2 to 4.0.1 by @dependabot in Bump flake8 from 3.9.2 to 4.0.1 #33
• Bump pyyaml from 5.4.1 to 6.0 by @dependabot in Bump pyyaml from 5.4.1 to 6.0 #32
• Add support and testing for Python 3.10 by @sdwilsh in Add support and testing for Python 3.10 #35

Full Changelog: https://github.com/sdwilsh/siobrultech-protocols/commits/v0.4.0

---

This discussion was created from the release v0.4.0.