mirror of
https://github.com/KevinMidboe/python-gpiozero.git
synced 2025-10-29 17:50:37 +00:00
Add 'Initialisation options' to docs
This commit is contained in:
Ben Nuttall
121
docs/inputs.md
121
docs/inputs.md
@@ -36,30 +36,34 @@ to:
|
||||
button = Button(2)
|
||||
```
|
||||
|
||||
The default behaviour is to set the *pull* state of the button to *up*. To
|
||||
change this behaviour, set the `pull_up` argument to `False` when creating your
|
||||
`Button` object.
|
||||
#### Initialisation options
|
||||
|
||||
```python
|
||||
button = Button(pin=2, pull_up=False)
|
||||
Button(pin=None, pull_up=True, bounce_time=None)
|
||||
```
|
||||
|
||||
### Methods
|
||||
| Argument | Description | Values | Default |
|
||||
| -------- | ----------- | ------ | ------- |
|
||||
| `pin` | The GPIO pin number the button is connected to. | Integer: `0` to `25` | *Required* |
|
||||
| `pull_up` | The pull state of the pin. `True` means pull up, `False` means pull down. | Boolean | `True` |
|
||||
| `bounce_time` | Specifies the length of time (in seconds) that the component will ignore changes in state after an initial change. | Integer or Float | `None` |
|
||||
|
||||
#### Methods
|
||||
|
||||
| Method | Description | Arguments |
|
||||
| ------ | ----------- | --------- |
|
||||
| `wait_for_press()` | Halt the program until the button is pressed. | `timeout` - The number of seconds to wait before proceeding if no event is detected. **Default: `None`** |
|
||||
| `wait_for_release()` | Halt the program until the button is released. | `timeout` - The number of seconds to wait before proceeding if no event is detected. **Default: `None`** |
|
||||
|
||||
### Properties
|
||||
#### Properties
|
||||
|
||||
| Property | Description | Type |
|
||||
| -------- | ----------- | ---- |
|
||||
| `pin` | The GPIO pin number the button is connected to. | Integer |
|
||||
| `is_pressed` | The current state of the pin (`True` if pressed; otherwise `False`). | Boolean |
|
||||
| `pull_up` | The pull state of the pin (`True` if pulled up; `False` if pulled down). | Boolean |
|
||||
| `when_pressed` | A reference to the function to be called when the button is pressed. | None or Function |
|
||||
| `when_released` | A reference to the function to be called when the button is released. | None or Function |
|
||||
| `pin` | The GPIO pin number the button is connected to. | Integer |
|
||||
| `is_pressed` | The current state of the pin (`True` if pressed; otherwise `False`). | Boolean |
|
||||
| `pull_up` | The pull state of the pin (`True` if pulled up; `False` if pulled down). | Boolean |
|
||||
| `when_pressed` | A reference to the function to be called when the button is pressed. | `None` or Function |
|
||||
| `when_released` | A reference to the function to be called when the button is released. | `None` or Function |
|
||||
|
||||
## Motion Sensor
|
||||
|
||||
@@ -87,21 +91,35 @@ connected to:
|
||||
pir = MotionSensor(4)
|
||||
```
|
||||
|
||||
### Methods
|
||||
#### Initialisation options
|
||||
|
||||
```python
|
||||
MotionSensor(pin=None, queue_len=1, sample_rate=10, threshold=0.5, partial=False)
|
||||
```
|
||||
|
||||
| Argument | Description | Values | Default |
|
||||
| -------- | ----------- | ------ | ------- |
|
||||
| `pin` | The GPIO pin number the sensor is connected to. | Integer: `0` to `25` | *Required* |
|
||||
| `queue_len` | ??? | Integer | `1` |
|
||||
| `sample_rate` | ??? | Integer | `10` |
|
||||
| `threshold` | Proportion of sensor values required to determine motion state. | Float: `0` to `1` | `0.5` |
|
||||
| `partial` | ??? | Boolean | `False` |
|
||||
|
||||
#### Methods
|
||||
|
||||
| Method | Description | Arguments |
|
||||
| ------ | ----------- | --------- |
|
||||
| `wait_for_motion()` | Halt the program until motion is detected. | `timeout` - The number of seconds to wait before proceeding if no motion is detected. **Default: `None`** |
|
||||
| `wait_for_no_motion()` | Halt the program until no motion is detected. | `timeout` - The number of seconds to wait before proceeding if motion is still detected. **Default: `None`** |
|
||||
|
||||
### Properties
|
||||
#### Properties
|
||||
|
||||
| Property | Description | Type |
|
||||
| -------- | ----------- | ---- |
|
||||
| `pin` | The GPIO pin number the sensor is connected to. | Integer |
|
||||
| `motion_detected` | The current state of the sensor (`True` if motion is detected; otherwise `False`). | Boolean |
|
||||
| `when_motion` | A reference to the function to be called when motion is detected. | None or Function |
|
||||
| `when_no_motion` | A reference to the function to be called when no motion is detected. | None or Function |
|
||||
| `when_motion` | A reference to the function to be called when motion is detected. | `None` or Function |
|
||||
| `when_no_motion` | A reference to the function to be called when no motion is detected. | `None` or Function |
|
||||
|
||||
## Light Sensor
|
||||
|
||||
@@ -126,21 +144,36 @@ connected to:
|
||||
light = LightSensor(4)
|
||||
```
|
||||
|
||||
### Methods
|
||||
#### Initialisation options
|
||||
|
||||
```python
|
||||
LightSensor(pin=None, queue_len=5, charge_time_limit=10,
|
||||
threshold=0.1, partial=False)
|
||||
```
|
||||
|
||||
| Argument | Description | Values | Default |
|
||||
| -------- | ----------- | ------ | ------- |
|
||||
| `pin` | The GPIO pin number the sensor is connected to. | Integer: `0` to `25` | *Required* |
|
||||
| `queue_len` | ??? | Integer | `5` |
|
||||
| `charge_time_limit` | Maximum amount of time allowed to determine darkness. | Integer | `10` |
|
||||
| `threshold` | Proportion of sensor values required to determine light level. | Float: `0` to `1` | `0.1` |
|
||||
| `partial` | ??? | Boolean | `False` |
|
||||
|
||||
#### Methods
|
||||
|
||||
| Method | Description | Arguments |
|
||||
| ------ | ----------- | --------- |
|
||||
| `wait_for_light()` | Halt the program until light is detected. | `timeout` - The number of seconds to wait before proceeding if light is not detected. **Default: `None`** |
|
||||
| `wait_for_dark()` | Halt the program until darkness is detected. | `timeout` - The number of seconds to wait before proceeding if darkness is not detected. **Default: `None`** |
|
||||
|
||||
### Properties
|
||||
#### Properties
|
||||
|
||||
| Property | Description | Type |
|
||||
| -------- | ----------- | ---- |
|
||||
| `pin` | The GPIO pin number the sensor is connected to. | Integer |
|
||||
| `light_detected` | The current state of the sensor (`True` if light; otherwise `False`). | Boolean |
|
||||
| `when_light` | A reference to the function to be called when light is detected. | None or Function |
|
||||
| `when_dark` | A reference to the function to be called when darkness is detected. | None or Function |
|
||||
| `pin` | The GPIO pin number the sensor is connected to. | Integer |
|
||||
| `light_detected` | The current state of the sensor (`True` if light; otherwise `False`). | Boolean |
|
||||
| `when_light` | A reference to the function to be called when light is detected. | `None` or Function |
|
||||
| `when_dark` | A reference to the function to be called when darkness is detected. | `None` or Function |
|
||||
|
||||
## Temperature Sensor
|
||||
|
||||
@@ -164,11 +197,15 @@ Create a `TemperatureSensor` object:
|
||||
temp = TemperatureSensor()
|
||||
```
|
||||
|
||||
### Methods
|
||||
#### Initialisation options
|
||||
|
||||
...
|
||||
|
||||
### Properties
|
||||
#### Methods
|
||||
|
||||
...
|
||||
|
||||
#### Properties
|
||||
|
||||
| Property | Description | Type |
|
||||
| -------- | ----------- | ---- |
|
||||
@@ -199,27 +236,40 @@ Create an `MCP3008` object:
|
||||
pot = MCP3008()
|
||||
```
|
||||
|
||||
Read the value of the device:
|
||||
|
||||
```python
|
||||
print(pot.value)
|
||||
```
|
||||
|
||||
Alternatively, access an input value with the `MCP3008`'s context manager:
|
||||
|
||||
```python
|
||||
with MCP3008() as pot:
|
||||
print(pot.value)
|
||||
# do something with pot
|
||||
```
|
||||
|
||||
It is possible to specify the `device` and the `channel` you wish to access.
|
||||
The previous example used the default value of `0` for each of these. To
|
||||
specify them, pass them in as arguments:
|
||||
#### Initialisation options
|
||||
|
||||
```python
|
||||
pot = MCP3008(device=1, channel=7)
|
||||
MCP3008(device=0, channel=0)
|
||||
```
|
||||
|
||||
| Argument | Description | Values | Default |
|
||||
| -------- | ----------- | ------ | ------- |
|
||||
| `device` | Which of the two Chip Select SPI pins to access. | Integer: `0` or `1` | `0` |
|
||||
| `channel` | Which of the 8 ADC channels to access. | Integer: `0` to `7` | `0` |
|
||||
|
||||
#### Methods
|
||||
|
||||
| Method | Description | Arguments |
|
||||
| ------ | ----------- | --------- |
|
||||
| `wait_for_light()` | Halt the program until light is detected. | `timeout` - The number of seconds to wait before proceeding if light is not detected. **Default: `None`** |
|
||||
| `wait_for_dark()` | Halt the program until darkness is detected. | `timeout` - The number of seconds to wait before proceeding if darkness is not detected. **Default: `None`** |
|
||||
|
||||
#### Properties
|
||||
|
||||
| Property | Description | Type |
|
||||
| -------- | ----------- | ---- |
|
||||
| `pin` | The GPIO pin number the sensor is connected to. | Integer |
|
||||
| `light_detected` | The current state of the sensor (`True` if light; otherwise `False`). | Boolean |
|
||||
| `when_light` | A reference to the function to be called when light is detected. | `None` or Function |
|
||||
| `when_dark` | A reference to the function to be called when darkness is detected. | `None` or Function |
|
||||
|
||||
## MCP3004 Analogue-to-Digital Converter
|
||||
|
||||
MCP3004 ADC (Analogue-to-Digital converter).
|
||||
@@ -227,4 +277,5 @@ MCP3004 ADC (Analogue-to-Digital converter).
|
||||
The MCP3004 chip provides access to up to 4 analogue inputs, such as
|
||||
potentiometers, and read their values in digital form.
|
||||
|
||||
The interface is identical to `MCP3008`.
|
||||
The interface is identical to `MCP3008`, except that only channels `0` to `3`
|
||||
are accessible.
|
||||
|
||||
Reference in New Issue
Block a user