-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
2 changed files
with
4 additions
and
8 deletions.
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,9 +3,7 @@ | |
A set of data logger(s) that will query purple air sensor(s) for data. That data will then be ingested into a TimeScaleDB PostGreSQL database, CSV files, or a SQLite3 database. To use these tools a PurpleAPI key is required. You can get API keys by sending an email to `[email protected]` with a first and last name to assign them to. | ||
|
||
| [![Behave Tests](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/behave_tests.yml/badge.svg?branch=main)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/behave_tests.yml) | [![PyPI Distributions](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/build_and_publish_to_pypi.yml/badge.svg?branch=main)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/build_and_publish_to_pypi.yml) | [![TestPyPI Distributions](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/build_and_publish_to_test_pypi.yml/badge.svg?branch=main)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/build_and_publish_to_test_pypi.yml) | [![Black](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/black.yml/badge.svg)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/black.yml) | | ||
| --------------- | --------------- | --------------- | --------------- | | ||
|
||
|
||
| --------------- | --------------- | --------------- | --------------- | | ||
|
||
| [![Pull Request Sphinx Docs Check](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/sphinx_build.yml/badge.svg)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/sphinx_build.yml) | [![pages-build-deployment](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/pages/pages-build-deployment) | [![CodeQL](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/carlkidcrypto/purpleair_data_logger/actions/workflows/github-code-scanning/codeql) | | | ||
| --------------- | --------------- | --------------- | --------------- | | ||
|
@@ -175,7 +173,6 @@ Out of the parameters in the file below "sensor_index" is required. The others a | |
See this [file](./sample_json_config_files/sample_single_sensor_request_json_file.json) for an example. | ||
> Note: `poll_interval_seconds` is also required. It can not be lower than `60`. This is a custom field not defined by the PAA documentation. | ||
> Note: Refer to the PurpleAirAPI (PAA) documentation for more information. <https://api.purpleair.com/#api-sensors-get-sensor-data> | ||
### PAA Multiple Sensor Request Example | ||
|
@@ -185,7 +182,6 @@ Out of the parameters in the file below "fields" is required. The others are all | |
See this [file](./sample_json_config_files/sample_multiple_sensor_request_json_file.json) for an example. | ||
> Note: `poll_interval_seconds` is also required. It can not be lower than `60`. This is a custom field not defined by the PAA documentation. | ||
> Note: Refer to the PurpleAirAPI (PAA) documentation for more information. <https://api.purpleair.com/#api-sensors-get-sensors-data> | ||
The below snippet is taken From the PurpleAirAPI (PAA) documentation: | ||
|
@@ -278,7 +274,6 @@ The rest of the settings are official PAA settings. They are the same as the [## | |
See this [file](./sample_json_config_files/sample_group_sensor_request_json_file.json) for an example. | ||
### PAA Local Sensor Request Example | ||
Out of the parameters in the file below all are custom settings and are required. | ||
|
@@ -287,4 +282,4 @@ Out of the parameters in the file below all are custom settings and are required | |
`poll_interval_seconds` - The poll interval to get information from local sensors on the network. | ||
See this [file](./sample_json_config_files/sample_local_sensor_request_json_file.json) for an example. | ||
See this [file](./sample_json_config_files/sample_local_sensor_request_json_file.json) for an example. |
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