Skip to content

Commit

Permalink
Update README.md - minor visual changes
Browse files Browse the repository at this point in the history
  • Loading branch information
ftylitak authored Oct 21, 2024
1 parent 8ff35f3 commit dc8d545
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,21 @@ A mini SDI-12 implementation for getting sensor info over UART using directional

**is_active** (address)
* args:
* SDI-12 sensor address. Typical range: 0-9.
* `address`: SDI-12 sensor address. Typical range: 0-9.
* returns:
* Boolean: whether the sensor has send back acknowledgment

**get_sensor_info** (address)
* args:
* SDI-12 sensor address. Typical range: 0-9.
* `address`: SDI-12 sensor address. Typical range: 0-9.
* returns:
* Tuple (manufacturer, model): The manufacturer and model name as reported by the sensor. If sensor is unreachable, returns `(None, None)`
* Tuple `(manufacturer, model)`: The manufacturer and model name as reported by the sensor. If sensor is unreachable, returns `(None, None)`

**get_sensor_info_ex** (address)
* args:
* SDI-12 sensor address. Typical range: 0-9.
* `address`: SDI-12 sensor address. Typical range: 0-9.
* returns:
* Tuple (manufacturer, model, version, extra_info): The manufacturer, model, version, extra_info name as reported by the sensor. If sensor is unreachable, returns `(None, None, None, None)`
* Tuple `(manufacturer, model, version, extra_info)`: The manufacturer, model, version, extra_info name as reported by the sensor. If sensor is unreachable, returns `(None, None, None, None)`

**get_measurement** (address, measurement_name="M", number_of_measurements_digit_count=1, force_wait_period=False)

Expand All @@ -42,10 +42,10 @@ Sends a request for data measurement to the sensor and returns the data provided
output: [1, 2, -3, 4.1, 5, 6, 7, 8, 9]
```
* 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!".
* number_of_measurements_digit_count: Defines the number of expected digits in response. Default is 1 for the responses 'atttn'.
* force_wait_period: ignore service requests between measurement request and measurement retrieval and wait for the period of time requrned by the measurement request response.
* `address`: 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!".
* `number_of_measurements_digit_count`: Defines the number of expected digits in response. Default is 1 for the responses 'atttn'.
* `force_wait_period`: ignore service requests between measurement request and measurement retrieval and wait for the period of time requrned by the measurement request response.
* 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 dc8d545

Please sign in to comment.