diff --git a/docs/examples/read_one_sample.out b/docs/examples/read_one_sample.out new file mode 100644 index 0000000..032406c --- /dev/null +++ b/docs/examples/read_one_sample.out @@ -0,0 +1,6 @@ + +PMSx003 4 samples on default format +2021-07-29 15:57:01: PM1 1.0, PM2.5 11.0, PM10 12.0 μg/m3 +2021-07-29 15:57:21: PM1 0.0, PM2.5 6.0, PM10 6.0 μg/m3 +2021-07-29 15:57:41: PM1 0.0, PM2.5 1.0, PM10 2.0 μg/m3 +2021-07-29 15:58:01: PM1 0.0, PM2.5 1.0, PM10 2.0 μg/m3 diff --git a/docs/examples/read_one_sample.py b/docs/examples/read_one_sample.py new file mode 100644 index 0000000..4930057 --- /dev/null +++ b/docs/examples/read_one_sample.py @@ -0,0 +1,17 @@ +""" +Read PMSx003 sensor on /dev/ttyUSB0. + +Use low-level reader methods for more granular +control of the sensor. +""" + +from pms.core import SensorReader + +reader = SensorReader(sensor="PMSx003", port="/dev/ttyUSB0") + +print("\nPMSx003 4 samples on default format") + +reader.open() +for _ in range(4): + print(reader.read_one()) +reader.close() diff --git a/docs/library_usage.md b/docs/library_usage.md index 7efc3a1..e9a7974 100644 --- a/docs/library_usage.md +++ b/docs/library_usage.md @@ -27,6 +27,16 @@ This section contain some help for those brave enough to use its internals as a --8<-- "read_two_sensors.out" ``` +=== "sensor stream (low-level API)" + + ``` python + --8<-- "sensor_stream.py" + ``` + + ``` + --8<-- "sensor_stream.out" + ``` + ## Observation data fields