[AE-51] Add documentation for BHY2Host #93
Closed
Conversation
This file contains hidden or 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
|
Memory usage change @ 9c3ff2a
Click for full report table
Click for full report CSV |
sebromero
requested changes
Jun 7, 2023
|
|
||
| // Necessary API. Update function should be continuously polled if PASSTHORUGH is ENABLED | ||
| /** | ||
| * @brief |
There was a problem hiding this comment.
Brief description missing
| * @brief | ||
| * | ||
| * @param passthrough Enable Serial port at 115200 bps | ||
| * @param niclaConnection Configuration for set @ref NiclaWiring state |
There was a problem hiding this comment.
Suggested change
| * @param niclaConnection Configuration for set @ref NiclaWiring state | |
| * @param niclaConnection Configuration for setting @ref NiclaWiring state. This is useful to configure the board to communicate either via ESLOV, BLE or both. It's also possible to mount the Nicla Sense ME as a shield. In that case you need to pass `NICLA_AS_SHIELD` to this parameter. |
Comment on lines
+50
to
+51
| * @return true Connection successful to the Nicla board | ||
| * @return false Connection unsuccessful to the Nicla board |
There was a problem hiding this comment.
According to our style guide we should use a single @return statement.
| */ | ||
| bool begin(bool passthrough = false, NiclaWiring niclaConnection = NICLA_VIA_ESLOV); | ||
| /** | ||
| * @brief Pings sensor |
There was a problem hiding this comment.
Suggested change
| * @brief Pings sensor | |
| * @brief Requests new sensor data from the client (Nicla Sense ME) and saves it locally so it can be retrieved via `Sensor` objects. |
| */ | ||
| void update(); | ||
| /** | ||
| * @brief Pings sensor and then sleep |
There was a problem hiding this comment.
Suggested change
| * @brief Pings sensor and then sleep | |
| * @brief Requests new sensor data from the client (Nicla Sense ME) and saves it locally so it can be retrieved via `Sensor` objects. The Nicla Sense ME's sensors are then put to sleep for the given amount of milliseconds. |
| */ | ||
| uint8_t requestAvailableData(); | ||
| /** | ||
| * @brief Obtain long data sent over ESLOV to the host board |
There was a problem hiding this comment.
Same comment as for requestAvailableData()
| */ | ||
| uint8_t requestAvailableLongData(); | ||
| /** | ||
| * @brief Request data from the Nicla board |
There was a problem hiding this comment.
This is for a specific sensor, right? So do I need to pass the sensor ID or how does this work?
| * | ||
| * @param sData | ||
| * @return true Request successful | ||
| * @return false Request unsuccessful |
There was a problem hiding this comment.
Transmission error only or also configuration error?
| */ | ||
| bool requestSensorData(SensorDataPacket &sData); | ||
| /** | ||
| * @brief Request long data from the Nicla board |
There was a problem hiding this comment.
Same comment as for requestSensorData()
|
|
||
| protected: | ||
| /** | ||
| * @brief Nicla Sense ME is mounted as a Shield |
There was a problem hiding this comment.
What does the function do? Does it set some pins, change some configuration, ...?
|
Closing PR, changes are in #104 |
per1234
added
topic: documentation
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.
Description
Pull request type