Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ICOc User Interface Text & API Text for New Sensory Milling Hardware #23

Open
3 tasks
sanssecours opened this issue Jan 25, 2022 · 0 comments
Open
3 tasks
Labels
documentation Improvements or additions to documentation enhancement New feature or request usability Something does not work as assumed

Comments

@sanssecours
Copy link
Member

Description

Currently ICOc assumes that a (Bluetooth) sensor device is always a sensory tool holder (STH) or sensory holder assembly (SHA). Since we added new hardware (Sensory Milling Head) that is neither, we should make sure that the code, and user interface reflects these changes:

  • Use “sensor device” or “device” everywhere we used the term “STH” or SHA” in the user interface; While ideally the description should include the name of the actual hardware e.g. ”SMH” or “STH” we have no way to distinguish these devices in software yet.
  • Replace the term sth in the API with device or sensor_device; One example for such a function would be connect_sth in the Network class.
  • Update the documentation for the new hardware
@sanssecours sanssecours added documentation Improvements or additions to documentation enhancement New feature or request usability Something does not work as assumed labels Jan 25, 2022
@sanssecours sanssecours changed the title Update ICOc User Interface & API for New Sensory Milling Hardware Update ICOc User Interface Text & API Text for New Sensory Milling Hardware Jan 25, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request usability Something does not work as assumed
Projects
None yet
Development

No branches or pull requests

1 participant