Update docs for modular driver example consolidation #239
Conversation
examples/modular-drivers/README.md
Outdated
| ``` | ||
|
|
||
| Rebuild the project per the above Micro-RDK Development Setup | ||
| instructions and reflash the board. | ||
| instructions and reflash the board. We will be using the Wifi | ||
| RSSI Sensor and free heap sensor for this example, which used |
There was a problem hiding this comment.
I think you can strike the part after the comma about where it used to be.
examples/modular-drivers/README.md
Outdated
|
|
||
| The generated project also includes a `package.metadata` section in | ||
| its `Cargo.toml` which identifies the library crate as being a | ||
| Micro-RDK module: | ||
|
|
||
| https://github.com/viam-labs/micro-rdk-esp32-sensor-examples/blob/02d7c8e487a48ac7c8d527a5c7b750d6c2357a27/Cargo.toml#L12-L13 | ||
| https://github.com/viamrobotics/micro-rdk/blob/main/examples/modular-drivers/Cargo.toml#L18-19 |
There was a problem hiding this comment.
The old links were to specific commits so that they wouldn't become incorrect if small changes caused the lines to shift. I'd suggest making them work that way again. They can reference commit fbc1783
| @@ -108,28 +110,34 @@ platform. The generated project has the form of a library crate, where | |||
| `src/lib.rs` defines an initially empty implementation of the | |||
| well-known Micro-RDK module entry point `register_models`: | |||
|
|
|||
| https://github.com/viam-labs/micro-rdk-esp32-sensor-examples/blob/02d7c8e487a48ac7c8d527a5c7b750d6c2357a27/src/lib.rs#L3-L5 | |||
| ``` rust | |||
There was a problem hiding this comment.
⬆️ - This still says micro-rdk-esp32-sensor-examples.
examples/modular-drivers/README.md
Outdated
| ``` rust | ||
| use micro_rdk::common::registry::{ComponentRegistry, RegistryError}; | ||
|
|
||
| pub fn register_models(_registry: &mut ComponentRegistry) -> anyhow::Result<(), RegistryError> { |
There was a problem hiding this comment.
Yes, this seems fine to do since you don't have a commit containing the relevant code.
examples/modular-drivers/README.md
Outdated
|
|
||
| A subsequent commit adds definitions of the | ||
| [FreeHeapSensor](https://github.com/viam-labs/micro-rdk-esp32-sensor-examples/blob/9cc59d56cc35ab7cf0c471b613c5f3c2ab2ed95b/src/wifi_rssi_sensor.rs) | ||
| [FreeHeapSensor](https://github.com/viamrobotics/micro-rdk/blob/main/examples/modular-drivers/src/free_heap_sensor.rs) |
There was a problem hiding this comment.
Is there a way to make these links relative so the github.com/viamrobotics/micro-rdk part can be removed? Does
https://../../blob/... work?
examples/modular-drivers/README.md
Outdated
| ``` rust | ||
| use micro_rdk::common::registry::{ComponentRegistry, RegistryError}; | ||
|
|
||
| pub fn register_models(_registry: &mut ComponentRegistry) -> anyhow::Result<(), RegistryError> { |
There was a problem hiding this comment.
Please check that this is actually the signature. I don't think we still use anyhow so it may be stale.
There was a problem hiding this comment.
I was trying to preserve the original linked commit, but will update it!
examples/modular-drivers/README.md
Outdated
| - `FreeHeapSensor`: https://github.com/viamrobotics/micro-rdk/blob/main/examples/modular-drivers/src/free_heap_sensor.rs#L23-L27 | ||
| - `WifiRSSISensor`: https://github.com/viamrobotics/micro-rdk/blob/main/examples/modular-drivers/src/wifi_rssi_sensor.rs#L23-L27 | ||
|
|
||
| Finally, the top level `register_models` entry point is updated to delegate to the `register_model` function for both sensors: | ||
| Finally, the top level `register_models` entry point is updated to delegate to the `register_models` function for both sensors: | ||
|
|
||
| https://github.com/viam-labs/micro-rdk-esp32-sensor-examples/blob/9cc59d56cc35ab7cf0c471b613c5f3c2ab2ed95b/src/lib.rs#L6-L10 | ||
| https://github.com/viamrobotics/micro-rdk/blob/main/examples/modular-drivers/src/lib.rs#L10-L18 |
There was a problem hiding this comment.
The three links here should also reference fbc1783, not main. If possible, they should also be relative (i.e. no http://github.com/...).
|
|
||
| The generated project also includes a `package.metadata` section in | ||
| its `Cargo.toml` which identifies the library crate as being a | ||
| Micro-RDK module: | ||
|
|
||
| https://github.com/viam-labs/micro-rdk-esp32-sensor-examples/blob/02d7c8e487a48ac7c8d527a5c7b750d6c2357a27/Cargo.toml#L12-L13 | ||
| https://github.com/viamrobotics/micro-rdk/blob/fbc1783258bfefc027fd25a8cc9a1b37f6ea0524/examples/modular-drivers/Cargo.toml#L18-L19 |
I removed all references to the micrordk-esp32-sensor-modules folder in the viam-labs repo and updated the implementation logic so users aren't confused about why there are more modules than we are using in the tutorial.
The only thing I'm not 100% sure on is line 113-119 on examples/modular-drivers/README.md , as I'm removing a link to a previous commit in the micrordk-esp32-sensor-module that wasn't preserved when consolidating examples. I'm replacing it with the actual code snippet.