KevinMidboe/python-gpiozero
1
0
Fork 0
mirror of https://github.com/KevinMidboe/python-gpiozero.git synced 2025-12-08 20:39:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs clean up part 1

Browse Source 
Big push on getting the docs cleaned up before 1.0. Proper wrapping of
everything so it's decently viewable from the command line (or as
decently viewable as markdown can be - the tables will never look great
from the command line).

Only one code change in this PR: rename bouncetime to bounce_time
(everything else is PEP-8, so this probably should be too) and change
its units to seconds from milliseconds (again, all other durations in
the library are in seconds, so it feels inconsistent that this one
isn't; for the sake of those who won't read the docs - which is most
people - I figure consistency helps with guessing!).
This commit is contained in:
Dave Jones
2015-10-03 16:24:12 +01:00
parent 3a4d3d4deb
commit 7429c03117
9 changed files with 304 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/inputs.md
View File

@@ -1,10 +1,12 @@
# Input Devices
These input device component interfaces have been provided for simple use of everyday components.
These input device component interfaces have been provided for simple use of
everyday components.
Components must be wired up correctly before used in code.
*Note all GPIO pin numbers use BCM numbering. See the [notes](notes.md) page for more information.*
*Note all GPIO pin numbers use BCM numbering. See the [notes](notes.md) page
for more information.*
## Button
@@ -22,13 +24,16 @@ Ensure the `Button` class is imported at the top of the file:
from gpiozero import Button
```
Create a `Button` object by passing in the pin number the button is connected to:
Create a `Button` object by passing in the pin number the button is connected
to:
```python
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.
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.
```python
button = Button(pin=2, pull_up=False)
@@ -67,7 +72,8 @@ Ensure the `MotionSensor` class is imported at the top of the file:
from gpiozero import MotionSensor
```
Create a `MotionSensor` object by passing in the pin number the sensor is connected to:
Create a `MotionSensor` object by passing in the pin number the sensor is
connected to:
```python
pir = MotionSensor(3)
@@ -97,7 +103,8 @@ Ensure the `LightSensor` class is imported at the top of the file:
from gpiozero import LightSensor
```
Create a `LightSensor` object by passing in the pin number the sensor is connected to:
Create a `LightSensor` object by passing in the pin number the sensor is
connected to:
```python
light = LightSensor(4)
@@ -145,7 +152,8 @@ temp = TemperatureSensor()
MCP3008 ADC (Analogue-to-Digital converter).
The MCP3008 chip provides access to up to 8 analogue inputs, such as potentiometers, and read their values in digital form.
The MCP3008 chip provides access to up to 8 analogue inputs, such as
potentiometers, and read their values in digital form.
### Wiring
@@ -166,7 +174,9 @@ with MCP3008() as pot:
print(pot.read())
```
It is possible to specify the `bus`, 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:
It is possible to specify the `bus`, 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:
```python
with MCP3008(bus=1, device=1, channel=4) as pot: