Skip to content

Commit afb305f

Browse files
authored
Update README.md
1 parent c3ecf02 commit afb305f

File tree

1 file changed

+16
-7
lines changed

1 file changed

+16
-7
lines changed

README.md

Lines changed: 16 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
11
# PHPi
22

3-
**WIP - If you'd like to help send me a message!**
4-
53
Event driven bindings for the Raspberry Pi GPIO. Supports A, A+, B, Brev2, B+, 2B, 3B, Compute Module and Pi Zero.
64

75
This library interacts (almost) directly with the peripheral registers for maximum functionality and speed. See note on `mmap/dma`
@@ -22,10 +20,8 @@ This library will function without any kernel drivers/sysfs etc enabled.
2220

2321
Using composer:
2422

25-
```json
26-
"require": {
27-
"calcinai/phpi": "^0.1"
28-
}
23+
```
24+
composer require calcinai/phpi
2925
```
3026

3127
Although it is possible to add this to your own autoloader, it's not recommended as you'll have no control of the dependencies. If you haven't
@@ -88,7 +84,7 @@ interact with the ports more than a few hundred times/sec.
8884
### SPI
8985

9086
SPI is supported along with some device protocols (MPC300x etc). With the default python-mmap, it is limited to about 3kB/s before there is no CPU left! With
91-
the native extension, you can reach speeds of over 20kB/s.
87+
the native extension, you can reach speeds of over 30kB/s.
9288

9389

9490
### The event loop
@@ -98,3 +94,16 @@ that can be leveraged. A good example is the websocket server; it will run seam
9894
bidirectional, non-polling* interaction with the Pi from any modern browser.
9995

10096
See [phpi-websocket](https://github.com/calcinai/phpi-websocket) for more on this.
97+
98+
## External Devices
99+
100+
There are included helper classes for interfacing with common devices, with more added regulary.
101+
102+
* Generic Inputs/Outputs
103+
* Buttons
104+
* LEDs
105+
* Relays
106+
* ADC (MCP 3xxx series)
107+
* H Bridge Motors
108+
* 2 and 4 Phase stepper motors
109+

0 commit comments

Comments
 (0)