Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
with measurement_name argument in get_measurement
  • Loading branch information
ftylitak authored Feb 14, 2021
1 parent 30e624c commit 85de106
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ A mini SDI-12 implementation for getting sensor info over UART using directional
* returns:
* Tuple (manufacturer, model): The manufacturer and model name as reported by the sensor. If sensor is unreachable, returns `(None, None)`

**get_measurement** (address)
**get_measurement** (address, measurement_name="M")

Sends a request for data measurement to the sensor and returns the data provided by the sensor split into an array. Supports parsing all possible values provided through multiple sequential requests on the sensor. Example:
```
Expand All @@ -37,6 +37,7 @@ Sends a request for data measurement to the sensor and returns the data provided
```
* args:
* SDI-12 sensor address. Typical range: 0-9.
* measurement_name: Configures the name of the query. Default is "M" as the default query is "aM!".
* returns:
* Measurement data array: an array containing all the data collected from the sensor. For details on each data value, please advise sensor manufacturer manuals. If sensor is unreachable, returns `None`

Expand Down

0 comments on commit 85de106

Please sign in to comment.