Reverse order of MCP300X arguments, close #92

gpiozero · Nov 15, 2015 · 382d6e4 · 382d6e4
1 parent 492f311
commit 382d6e4
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 18 deletions.
diff --git a/docs/inputs.md b/docs/inputs.md
@@ -210,29 +210,22 @@ with MCP3008() as pot:
 #### Initialisation options
 
 ```python
-MCP3008(device=0, channel=0)
+MCP3008(channel=0, device=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`** |
+| `device`  | Which of the two Chip Select SPI pins to access. | Integer: `0` or `1` | `0` |
 
 #### 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 |
+| `channel` | The ADC channel the device is connected to.                   | Integer   |
+| `device`  | The chip select pin the device is connected to.               | Integer   |
+| `value`   | The current value of the device.                              | Float     |
+| `values`  | A generator continuously yielding the device's current value. | Generator |
 
 ## MCP3004 Analogue-to-Digital Converter
 

diff --git a/gpiozero/input_devices.py b/gpiozero/input_devices.py
@@ -3,7 +3,7 @@
     print_function,
     absolute_import,
     division,
-    )
+)
 
 import inspect
 import warnings
@@ -20,7 +20,7 @@
     GPIODevice,
     CompositeDevice,
     GPIOQueue,
-    )
+)
 
 
 class InputDeviceError(GPIODeviceError):
@@ -554,7 +554,7 @@ def value(self):
 
 
 class MCP3008(AnalogInputDevice):
-    def __init__(self, device=0, channel=0):
+    def __init__(self, channel=0, device=0):
         if not 0 <= channel < 8:
             raise InputDeviceError('channel must be between 0 and 7')
         super(MCP3008, self).__init__(device=device, bits=10)
@@ -590,9 +590,9 @@ def _read(self):
 
 
 class MCP3004(MCP3008):
-    def __init__(self, device=0, channel=0):
+    def __init__(self, channel=0, device=0):
         # MCP3004 protocol is identical to MCP3008 but the top bit of the
         # channel number must be 0 (effectively restricting it to 4 channels)
         if not 0 <= channel < 4:
             raise InputDeviceError('channel must be between 0 and 3')
-        super(MCP3004, self).__init__(device, channel)
+        super(MCP3004, self).__init__(channel, device)