Skip to content

Commit a53218a

Browse files
committed
Add 'Requirements' section to README
1 parent 41af0e2 commit a53218a

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ A pure Python SPI interface using the Linux spidev device
1212
- Supports half-duplex reads and writes as well as full-duplex transfers.
1313
- Exposes all available spidev interface options as properties.
1414

15+
## Requirements
16+
17+
- spidev enabled in the kernel and (if necessary) the device tree.
18+
- Write permissions to the /dev/spidevN.N device.
19+
- Some distributions have an 'spi' group for this purpose. If available, add this group to the user account and ensure the spidev device is group-writeable.
20+
- If no 'spi' group exists, a udev rule can be created to set the permissions of the spidev device.
21+
- As a last resort, running the python script as root should allow access to the spidev. **Note** This is not recommended. Use the 'spi' group or udev rules whenever possible.
22+
1523
## Example
1624

1725
import spi

0 commit comments

Comments
 (0)