Air Quality API #464
Merged
Air Quality API #464
Conversation
This file contains 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
I've written the base of air_quality API, next I will add a fake sensor for testing the API, including unit testing for the fake sensor
I've removed the `AirQualityListener` and used a `Cell<Option<(u32,)>>` instead. I've added a private Enum for choosing what kind of data reading to execute, a private method that uses this Enum and two other public functions as wrappers.
I've added a fake `AirQuality` driver and some integration tests for it. Every test is passed and should reflect the behaviour of the real driver.
I've added unittests for each function of the AirQuality API, all pass as expected. Documentation for the API will be part of the next commit.
Added the suggested changes, including the `read_sync` function that return a tuple of both CO2 and TVOC values. Improved the unittests for the fake driver and added a unittest for the new function.
jrvanwhy
approved these changes
Apr 18, 2023
jrvanwhy
approved these changes
Apr 19, 2023
jrvanwhy
added
the
upkeep
alexandruradovici
requested changes
May 2, 2023
alexandruradovici
requested changes
May 5, 2023
I've added back the dedicated listener for this API and rewritten the returning errors of some functions.
alexandruradovici
approved these changes
May 16, 2023
bors bot
added a commit
that referenced
this pull request
May 16, 2023
464: Air Quality API r=jrvanwhy a=RaresCon ### Pull Request Overview This PR adds an Air Quality API, which includes: - function for checking the existence of the driver - functions for initating readings for CO2 and TVOC levels - a private function and enum for synchronous reading of values for CO2 and TVOC levels and 3 public functions for easier use of the API - unit tests Alongside the API, this PR adds a fake driver (and unit tests for it) for testing the API. ### Testing Strategy This pull request was tested using unit tests made specifically for this API and fake driver. ### TODO or Help Wanted This pull request still needs feedback / code review. I will add documentation in the files and an example application using this API. ### Documentation Updated - [x] No updates required. Co-authored-by: RaresCon <rares.constantin2002@gmail.com> Co-authored-by: Rareș Constantin <95525840+RaresCon@users.noreply.github.com>
|
Build failed: |
jrvanwhy
reviewed
May 16, 2023
alexandruradovici
requested changes
May 17, 2023
I've added some documentation for the functions of the API and fixed an inclusion bug of the API in `tests.rs` that made the CI fail.
alexandruradovici
approved these changes
May 19, 2023
|
Build succeeded! The publicly hosted instance of bors-ng is deprecated and will go away soon. If you want to self-host your own instance, instructions are here. If you want to switch to GitHub's built-in merge queue, visit their help page. |
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.
Pull Request Overview
This PR adds an Air Quality API, which includes:
Alongside the API, this PR adds a fake driver (and unit tests for it) for testing the API.
Testing Strategy
This pull request was tested using unit tests made specifically for this API and fake driver.
TODO or Help Wanted
This pull request still needs feedback / code review.
I will add documentation in the files and an example application using this API.
Documentation Updated