melfely/rnavp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

readme and comment changes

Browse Source
This commit is contained in:
Zander Johnson
2026-05-24 10:38:51 -05:00
parent d9f11b3f8e
commit 42f20b303d
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+3 -1
View File
@@ -1,4 +1,6 @@
# Robotics Navigation and Control Via Postcard *RNavP* # *RNavP*
## Robotics Navigation and Control Via Postcard
This is a crate designed to assit in development for the entire stack from the MCU(Running Embassy) to a STD computer talking to that MCU Via postcard for Drivetrain control. This is a crate designed to assit in development for the entire stack from the MCU(Running Embassy) to a STD computer talking to that MCU Via postcard for Drivetrain control.
Designed for intergration with ROS2 but is *NOT* required and will work for any STD enviroment for the control system Designed for intergration with ROS2 but is *NOT* required and will work for any STD enviroment for the control system
src/core/motor.rs
+1 -1
View File
@@ -116,7 +116,7 @@ pub trait Driver {
/// Some sensors may also provide current and voltage feedback, if implemented the communication system can sync them to the host you for. /// Some sensors may also provide current and voltage feedback, if implemented the communication system can sync them to the host you for.
/// Can also be used for other custom logic. They are unused by RNavP, entirely optional. /// Can also be used for other custom logic. They are unused by RNavP, entirely optional.
pub trait Sensor { pub trait Sensor {
///Returns the speed struct value from the motors sensor ///Returns the speed struct value from the motors sensor.
/// This should be non-blocking, there should be some form of cached value ready to go as soon as the method is called /// This should be non-blocking, there should be some form of cached value ready to go as soon as the method is called
/// ///
/// IF properly returned in the correct Enum Data field, all other systems will use the value propely, being unit agnostic later. /// IF properly returned in the correct Enum Data field, all other systems will use the value propely, being unit agnostic later.