Interface improvements #123
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- added alternate constructors `from_serial` and `from_udp` that combine instance creation and connection - added `__enter__` and `__exit__` methods to allow using in a context manager (`initialize` on entry, `close` connection on exit)
Minor update: new interface functionality (alternate constructors, context managers), but still backwards compatible. - adds Ping360 example + simulation Need to interactive rebase to appear after the new files actually exist
Need to overhaul so that it actually works, and is a good example. - ideally want to use sub-parsers for serial vs udp - needs to do something meaningful when it runs (although that could just be setting some settings and doing a full revolution or few)
- simplify to use boolean operator short-circuiting - use super instead of explicit parent class name
Resetting can cause issues with using the sonar again until it's power cycled Particularly relevant given we currently don't have discovery messages implemented.
Using a dedicated datastructure improves robustness (you can't forget a field, and all payloads have the same fields). A NamedTuple adds typing (requires Python >= 3.6) and reduces memory usage and attribute access time.
- separated data-buffer construction into its own method (`from_buffer`) - improved primary constructor to allow specifying message data directly
ES-Alexander
commented
Apr 15, 2022
| self.payload_format = self.get_payload_format() | ||
| except KeyError as e: | ||
| message_id = self.message_id | ||
| raise Exception(f"{message_id = } not recognized\n{msg_data = }") from e |
There was a problem hiding this comment.
f-string f'{var=}' syntax requires Python >= 3.8
-> should specify in commit message
-> should update minimum version in setup.py
There was a problem hiding this comment.
We can update to 1.* version, do all the necessary syntax corrections and move to python 3.9
ES-Alexander
commented
Dec 14, 2023
| @@ -163,29 +159,32 @@ if __name__ == "__main__": | |||
|
|
|||
| print("full scan in %dms, %dHz" % (1000*(tend_s - tstart_s), 400/(tend_s - tstart_s))) | |||
|
|
|||
| # turn on auto-scan with 1 grad steps | |||
| p.control_auto_transmit(0,399,1,0) | |||
| if p.firmware_version > (3, 1, 1): | |||
There was a problem hiding this comment.
This should be a check against protocol version (>= 1.1.0), not firmware version (different devices supporting the protocol may have different firmware versions).
ES-Alexander
commented
Dec 14, 2023
| import time | ||
|
|
||
| class Ping360(PingDevice): | ||
| messages = definitions.Ping360Message | ||
|
|
||
| def initialize(self): |
There was a problem hiding this comment.
Would be good to include a protocol version check here, that prints a warning about auto messages not being supported if the protocol is < v1.1.0.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
from_serialandfrom_udpthat combine instance creation and connection__enter__and__exit__methods to allow using in a context manager (initializeon entry,closeconnection on exit)examples/simplePing360Example.pytools/ping360-simulation.pyscriptset_rangefunctionality for Ping360 #122setup.pyupdate to the end