Skip to content

Commit 40c2f77

Browse files
authored
Encoder README update
1 parent 8c1b110 commit 40c2f77

File tree

1 file changed

+19
-15
lines changed

1 file changed

+19
-15
lines changed

Adafruit_BBIO/README.md

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
# Adafruit_BBIO.Encoder module
22

3-
Initially based on the [PyBBIO](https://github.com/graycatlabs/PyBBIO/bbio/libraries/RotaryEncoder/rotary_encoder.py) rotary encoder code.
4-
53
This module enables access to the Beaglebone Black enhanced Quadrature Encoder Pulse (eQEP) modules: eQEP0, eQEP1 and eQEP2.
64

5+
Initially based on the [PyBBIO](https://github.com/graycatlabs/PyBBIO/bbio/libraries/RotaryEncoder/rotary_encoder.py) rotary encoder code.
6+
77
## Prerequisites
88

99
These instructions are based on a 4.4.x Linux kernel.
1010

11-
In order to use all eQEP pins the BeagleBone must:
11+
In order to use all eQEP pins the BeagleBone must boot with the [cape-universal](https://github.com/beagleboard/bb.org-overlays/tree/master/tools/beaglebone-universal-io) enabled, and load the cape-universal overlay
1212

13-
1. boot with cape-universal enabled, and
14-
2. load the cape-universala overlay
13+
```
14+
enable_uboot_cape_universal=1
15+
```
1516

1617
Notes:
17-
- It would seem that `cape_universal` is [enabled by default already](https://groups.google.com/d/msg/beagleboard/2D5Pz3r7ZZ8/bLKcvHbGDgAJ) from kernel 4.1.x onwards. As such, the first step is not necessary.
18-
- An alternative option to the `cape-universala` overlay would be to load one of the [dedicated eQEP overlays](https://github.com/Teknoman117/beaglebot/tree/master/encoders/dts).
18+
- An alternative option to the `cape-universal` overlay would be to load one of the [dedicated eQEP overlays](https://github.com/Teknoman117/beaglebot/tree/master/encoders/dts).
1919

2020
### Install/upgrade the latest Device Tree overlays
2121

@@ -25,23 +25,27 @@ sudo apt-get upgrade bb-cape-overlays
2525

2626
### Load the universal cape
2727

28-
Modify the `/boot/uEnv.txt` file to contain these two lines:
28+
If it doesn't already contain it, modify the `/boot/uEnv.txt` file to contain this line:
2929

3030
```
31-
cmdline=coherent_pool=1M net.ifnames=0 quiet cape_universal=enable
31+
enable_uboot_cape_universal=1
3232
```
3333

34-
```
35-
cape_enable=bone_capemgr.enable_partno=cape-universala
36-
```
34+
Notes:
3735

38-
### Check slots
36+
- Some older documentation recommends using these two lines instead. They are meant to load deprecated kernel-based overlays and it's not recommended to use them. Use the new way of [loading overlays via uboot](https://elinux.org/Beagleboard:BeagleBoneBlack_Debian#U-Boot_Overlays) instead, as instructed above.
3937

40-
TBD
38+
```
39+
cmdline=cape_universal=enable # Plus some other options
40+
```
41+
```
42+
cape_enable=bone_capemgr.enable_partno=cape-universala
43+
```
44+
- TBD: check the overlays that are currently loaded
4145

4246
## eQEP configuraton
4347

44-
Note: if either eQEP 1 or eQEP 2 are used on the Beaglebone Black, video must be disabled, as their pins are shared with the LCD_DATAx lines of the HDMI interface.
48+
Note: if either eQEP1 or eQEP2b are used on the Beaglebone Black, video must be disabled, as their pins are shared with the LCD_DATAx lines of the HDMI interface.
4549

4650
### eQEP0
4751

0 commit comments

Comments
 (0)