cu-rp-encoder 0.13.0

This is a driver for the Raspberry Pi to decode a directional encoder from GPIOs.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

# Raspberry Pi based encoder driver for Copper

This driver is for the Raspberry Pi based encoder driver for Copper.

## Compatibility

Any encoder with a base clock + a direction trigger.

## Usage

On Linux hardware, provide both GPIO inputs through resource bindings:

```ron
resources: [
    (
        id: "enc",
        provider: "cu_linux_resources::LinuxResources",
        config: {
            "gpio_in0_pin": 17,
            "gpio_in1_pin": 18,
        },
    ),
],
tasks: [
    (
        id: "src",
        type: "cu_rp_encoder::Encoder",
        resources: {
            clk_pin: "enc.gpio_in0",
            dat_pin: "enc.gpio_in1",
        },
    ),
]
```

In `mock` mode, pins can be supplied through task config:

```ron
    tasks: [
        (
            id: "src",
            type: "cu_rp_encoder::Encoder",
            params: {
                clk_pin: 17,
                dat_pin: 18,
            },
        ),
    ]
```

The `clk_pin` is the pin for the clock signal and the `dat_pin` is the pin for the direction signal.

When you connect this driver to the rest of the system you need to use the `cu_rp_encoder::EncoderMsg` message type.

```ron
    cnx: [
        (src: "src",  dst: "dst",   msg: "cu_rp_encoder::EncoderMsg"),
    ],
```

It has been tested with a Hall effect encoder like this one:

<img alt="The encoder" src="doc/encoder.jpg">