Create NPM package of React components and types #58
Description
The daphbot-due webapp has several React and Typescript components that would benefit anyone developing a web front-end for a basic_bot project.
We can possibly host on my NPM publisher account.
Requirements:
- unit tests for all components exported from lib
- documentation that shows each component and has documentation for each component
- documentation added on components should live as close to or in the code of the component to prevent staleness and increase the odds of the docs staying up to date with the code.
Would be nice:
- some sort of playground? Not even sure if this is possible without using something like ... redacted: I don't want to give the AI any ideas or direction, and I'm also not a huge fan of the one product that came to mind. (psst sT()rY📚 are difficult to maintain and tend to get stale IMHO.
Initial Components to support:
I think the components and utils below represent the few things from daphbot-due's webapp that many other types of robots would need.
- Components from daphbot-due:
- ObjectsOverlay - draws boxes around recognition objects.
- PanTilt - Touchscreen (mouse) joystick controlling two servos, respectively named "pan" and "tilt".
- VideoFeed - For displaying the MJPEG stream from basic_bot vision service.
- WebRTCVideoClient - For displaying the WebRTC audio and video streams from the robot vision service.
- utils from daphbot-due:
- hubState.ts - provides typescript types for the full possible state of basic_bot included services plus methods for connecting to, and tracking state changes locally. Needs some work to detach from daphbot-due specific stuff. Maybe the type information would be better in a different file that the code for connecting? IDK ICD
- hubMessages.ts - provides convenience method for sending state updates; depends on hubState.js