Skip to content

Commit 871e82d

Browse files
committed
Add contribution notes
1 parent 70e78e0 commit 871e82d

File tree

1 file changed

+62
-60
lines changed

1 file changed

+62
-60
lines changed

CHANGELOG.md

+62-60
Original file line numberDiff line numberDiff line change
@@ -2,82 +2,84 @@
22

33
## 0.2.1
44

5-
* Support for Raspberry Pi 4
5+
- Change license to MIT OR Apache-2.0 and add support for Raspberry Pi 4
66

7-
- upgraded [rppal](https://github.com/golemparts/rppal/) to `0.12.0`. See [Issue #12](https://github.com/rahul-thakoor/rust_gpiozero/issues/23)
7+
- Fix clippy and fmt warnings. Thanks @AldaronLau
8+
9+
- change license to either of MIT OR Apache-2.0. Thanks @owenbrooks
10+
11+
- upgraded [rppal](https://github.com/golemparts/rppal/) to `0.12.0`. See [Issue #22](https://github.com/rahul-thakoor/rust_gpiozero/issues/22) and [Issue #23](https://github.com/rahul-thakoor/rust_gpiozero/issues/23). Thanks @dmalenic
812

913
## 0.2.0
14+
1015
`rust_gpiozero` now uses [rppal](https://github.com/golemparts/rppal/) for gpio access
1116

12-
* **input_devices**
17+
- **input_devices**
18+
1319
- **InputDevice** changes:
14-
+ `pin` is now `u8`
15-
+ `new` configures device with the pin pulled to low by default
16-
+ Added `new_with_pullup`: create InputDevice with the pin number given with the pin pulled high with an internal resistor by default
17-
+ `value` returns a `bool`
20+
21+
- `pin` is now `u8`
22+
- `new` configures device with the pin pulled to low by default
23+
- Added `new_with_pullup`: create InputDevice with the pin number given with the pin pulled high with an internal resistor by default
24+
- `value` returns a `bool`
1825

1926
- **DigitalInputDevice** changes:
20-
+ `pin` is now `u8`
21-
+ `new` configures device with the pin pulled to low by default
22-
+ Added `new_with_pullup`: create InputDevice with the pin number given with the pin pulled high with an internal resistor by default
23-
+ `value` returns a `bool`
24-
+ `wait_for_inactive` takes an argument `timeout` (Option<f32>)
25-
+ `wait_for_active` takes an argument `timeout` (Option<f32>)
26-
27+
- `pin` is now `u8`
28+
- `new` configures device with the pin pulled to low by default
29+
- Added `new_with_pullup`: create InputDevice with the pin number given with the pin pulled high with an internal resistor by default
30+
- `value` returns a `bool`
31+
- `wait_for_inactive` takes an argument `timeout` (Option<f32>)
32+
- `wait_for_active` takes an argument `timeout` (Option<f32>)
2733
- **Button** changes:
28-
+ `pin` is now `u8`
29-
+ `new` configures device with the pin pulled to `high` by default
30-
+ Added `new_with_pulldown`: create InputDevice with the pin number given with the pin pulled low with an internal resistor by default
31-
+ `value` returns a `bool`
32-
+ `wait_for_inactive` takes an argument `timeout` (Option<f32>)
33-
+ `wait_for_active` takes an argument `timeout` (Option<f32>)
34-
35-
* **output_devices**
34+
- `pin` is now `u8`
35+
- `new` configures device with the pin pulled to `high` by default
36+
- Added `new_with_pulldown`: create InputDevice with the pin number given with the pin pulled low with an internal resistor by default
37+
- `value` returns a `bool`
38+
- `wait_for_inactive` takes an argument `timeout` (Option<f32>)
39+
- `wait_for_active` takes an argument `timeout` (Option<f32>)
40+
41+
- **output_devices**
42+
3643
- **PWMOutputDevice** (New)
37-
+ A generic output device configured for software pulse-width modulation (PWM)
38-
+ Values can be specified between 0.0 and 1.0 for varying levels of power in the device.
39-
44+
- A generic output device configured for software pulse-width modulation (PWM)
45+
- Values can be specified between 0.0 and 1.0 for varying levels of power in the device.
4046
- **PWMLED** (New)
41-
+ Represents a light emitting diode (LED) with variable brightness.
42-
+ Values can be specified between 0.0 and 1.0 for varying levels of brightness.
43-
47+
48+
- Represents a light emitting diode (LED) with variable brightness.
49+
- Values can be specified between 0.0 and 1.0 for varying levels of brightness.
50+
4451
- **Servo** (New)
45-
+ Represents a PWM-controlled servo motor connected to a GPIO pin
46-
52+
- Represents a PWM-controlled servo motor connected to a GPIO pin
4753
- **OutputDevice** changes:
48-
+ `pin` is now `u8`
49-
+ Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
50-
+ Added `set_active_high` to set the state for `active_high`
51-
54+
- `pin` is now `u8`
55+
- Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
56+
- Added `set_active_high` to set the state for `active_high`
5257
- **DigitalOutputDevice** changes:
53-
+ `pin` is now `u8`
54-
+ Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
55-
+ Added `set_active_high` to set the state for `active_high`
56-
+ Added `blink` to make the device turn on and off repeatedly in the background.
57-
+ Added `set_blink_count`to set the number of times to blink the device
58-
+ Added `wait` which blocks until background blinking process is done
59-
58+
- `pin` is now `u8`
59+
- Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
60+
- Added `set_active_high` to set the state for `active_high`
61+
- Added `blink` to make the device turn on and off repeatedly in the background.
62+
- Added `set_blink_count`to set the number of times to blink the device
63+
- Added `wait` which blocks until background blinking process is done
6064
- **LED** changes:
61-
+ `pin` is now `u8`
62-
+ Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
63-
+ Added `set_active_high` to set the state for `active_high`
64-
+ `blink` now takes `f32` for `on_time` and `off_time`.
65-
+ Added `set_blink_count`to set the number of times to blink the device
66-
+ Added `wait` which blocks until background blinking process is done
67-
+ Added `is_lit` which returns True if the device is currently active and False otherwise.
68-
65+
- `pin` is now `u8`
66+
- Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
67+
- Added `set_active_high` to set the state for `active_high`
68+
- `blink` now takes `f32` for `on_time` and `off_time`.
69+
- Added `set_blink_count`to set the number of times to blink the device
70+
- Added `wait` which blocks until background blinking process is done
71+
- Added `is_lit` which returns True if the device is currently active and False otherwise.
6972
- **Buzzer** changes:
70-
+ `pin` is now `u8`
71-
+ Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
72-
+ Added `set_active_high` to set the state for `active_high`
73-
+ Added `beep` to make the device turn on and off repeatedly in the background.
74-
+ Added `set_beep_count`to set the number of times to beep the device
75-
+ Added `wait` which blocks until background beeping process is done
76-
+ Removed `blink` method
77-
73+
- `pin` is now `u8`
74+
- Added `active_high`: When True, the value property is True when the device's pin is high. When False the value property is True when the device's pin is low (i.e. the value is inverted).
75+
- Added `set_active_high` to set the state for `active_high`
76+
- Added `beep` to make the device turn on and off repeatedly in the background.
77+
- Added `set_beep_count`to set the number of times to beep the device
78+
- Added `wait` which blocks until background beeping process is done
79+
- Removed `blink` method
7880
- **Motor** changes:
79-
+ `forward_pin` and `backward_pin`are now `u8`
80-
+ Added `set_speed` method: Use `set_speed` to change the speed at which motors should turn. Can be any value between 0.0 and the default 1.0 (maximum speed)
81+
- `forward_pin` and `backward_pin`are now `u8`
82+
- Added `set_speed` method: Use `set_speed` to change the speed at which motors should turn. Can be any value between 0.0 and the default 1.0 (maximum speed)
8183

82-
* **device**
84+
- **device**
8385
- Renamed `GPIODevice` to `GpioDevice`

0 commit comments

Comments
 (0)