|
7 | 7 |
|
8 | 8 | `Circuits.GPIO` lets you use GPIOs in Elixir. |
9 | 9 |
|
10 | | -*This is the v2.0 development branch. If you're still using v1, please see the [maint-v1.x branch](https://github.com/elixir-circuits/circuits_gpio/tree/maint-v1.x).* |
11 | | - |
12 | | -`Circuits.GPIO` v2.0 is an almost backwards compatible update to `Circuits.GPIO` |
13 | | -v1.x. Here's what's new: |
14 | | - |
15 | | -* Linux or Nerves are no longer required. In fact, the NIF supporting them won't |
16 | | - be compiled if you don't want it. |
17 | | -* GPIOs can be enumerated to see what's available (See `Circuits.GPIO.enumerate/0`) |
18 | | -* Linux and Nerves now use the Linux GPIO cdev subsystem rather than sysfs |
19 | | -* GPIO pull mode setting for all platforms that support it rather than only Raspberry Pi |
20 | | -* Develop using simulated GPIOs to work with LEDs and buttons with |
21 | | - [CircuitsSim](https://github.com/elixir-circuits/circuits_sim) |
22 | | - |
23 | | -If you've used `Circuits.GPIO` v1.x, nearly all of your code will be the |
24 | | -same.`Circuits.GPIO` offers a substantial improvement by more descriptive GPIO |
25 | | -specs for identifying GPIOs. You can still refer to GPIOs by number. However, |
26 | | -you can also refer to GPIOs by labels and by which GPIO controller handles them. |
27 | | -The new `enumerate/0` can help with this. |
28 | | - |
29 | | -Please review the [porting guide](PORTING.md) when upgrading from v1.x. |
30 | | - |
31 | 10 | ## Getting started on Nerves and Linux |
32 | 11 |
|
33 | 12 | If you're natively compiling `circuits_gpio` using Nerves or using a Linux-based |
@@ -308,6 +287,31 @@ iex> Circuits.GPIO.read(gpio1) |
308 | 287 |
|
309 | 288 | Test mode is fairly limited, but it does support interrupts. |
310 | 289 |
|
| 290 | +## Migration from v1.x |
| 291 | + |
| 292 | +v2.x is the current version of `Circuits.GPIO`. |
| 293 | + |
| 294 | +`Circuits.GPIO` v2.0 is an almost backwards compatible update to `Circuits.GPIO` |
| 295 | +v1.x. Here's what's new: |
| 296 | + |
| 297 | +* Linux or Nerves are no longer required. In fact, the NIF supporting them won't |
| 298 | + be compiled if you don't want it. |
| 299 | +* GPIOs can be enumerated to see what's available (See `Circuits.GPIO.enumerate/0`) |
| 300 | +* Linux and Nerves now use the Linux GPIO cdev subsystem rather than sysfs |
| 301 | +* GPIO pull mode setting for all platforms that support it rather than only Raspberry Pi |
| 302 | +* Develop using simulated GPIOs to work with LEDs and buttons with |
| 303 | + [CircuitsSim](https://github.com/elixir-circuits/circuits_sim) |
| 304 | + |
| 305 | +If you've used `Circuits.GPIO` v1.x, nearly all of your code will be the |
| 306 | +same.`Circuits.GPIO` offers a substantial improvement by more descriptive GPIO |
| 307 | +specs for identifying GPIOs. You can still refer to GPIOs by number. However, |
| 308 | +you can also refer to GPIOs by labels and by which GPIO controller handles them. |
| 309 | +The new `enumerate/0` can help with this. |
| 310 | + |
| 311 | +If you are using a previous version and wish to update, review the [porting |
| 312 | +guide](PORTING.md). Also see [circuits_gpio v1.x maintenance |
| 313 | +branch](https://github.com/elixir-circuits/circuits_gpio/tree/maint-v1.x). |
| 314 | + |
311 | 315 | ## FAQ |
312 | 316 |
|
313 | 317 | ### Where can I get help? |
|
0 commit comments