public_git
/
pikvm
mirror of https://github.com/pikvm/pikvm.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update gpio.md

This commit is contained in:
Maxim Devaev 2020-09-10 16:36:03 +03:00 committed by GitHub
parent 3d00729024
commit f00878428d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 84 additions and 81 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
pages/gpio.md
View File

@ -9,12 +9,13 @@ that can also be used transparently by emulating abstract GPIO API.
# Configuration # Configuration
Setting up GPIO is quite complex. The interface is divided into several layers for flexibility. All configuration is performed using a file `/etc/kvmd/override.yaml` which has the [YAML syntax](https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html). We will look at each part of the configuration separately in a small test example. Setting up GPIO is quite complex. The interface is divided into several layers for flexibility. All configuration is performed using a file `/etc/kvmd/override.yaml` which has the [YAML syntax](https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html). We will look at each part of the configuration separately in a small test example.
* **Drivers** is the first layer that reflects the hardware that represents the IO ports (standard GPIO of Raspberry Pi, USB relay, and so on). Each driver has a type (a plugin that implements the hardware support) and an unique name. Multiple drivers of the same type can be defined at the same time. ### Drivers
The first layer that reflects the hardware that represents the IO ports (standard GPIO of Raspberry Pi, USB relay, and so on). Each driver has a type (a plugin that implements the hardware support) and an unique name. Multiple drivers of the same type can be defined at the same time.
For example, you can connect multiple relays and give each one its own name. By default, one driver is configured with the name `__gpio__`, representing the physical GPIO interface of the Raspberry Pi. For example, you can connect multiple relays and give each one its own name. By default, one driver is configured with the name `__gpio__`, representing the physical GPIO interface of the Raspberry Pi.
```yaml ```yaml
kvmd: kvmd:
gpio: gpio:
drivers: drivers:
# This example shows how the __gpio__ driver is defined. You don't need to write it in your configuration. # This example shows how the __gpio__ driver is defined. You don't need to write it in your configuration.
@ -31,16 +32,17 @@ Setting up GPIO is quite complex. The interface is divided into several layers f
relay: relay:
type: hidrelay type: hidrelay
device: /dev/hidraw0 device: /dev/hidraw0
``` ```
* **Scheme** is the second layer that reflects how the various driver ports are configured. Each port has a unique name, mode (`input` or `output`), a pin number, and refers to the driver that provides it. ### Scheme
The second layer that reflects how the various driver ports are configured. Each port has a unique name, mode (`input` or `output`), a pin number, and refers to the driver that provides it.
Two interaction modes are available for outputs: `pulse` and `switch`. In pulse mode, the output quickly switches its state to logical 1 and back (just like a button). In switch mode, it saves the state that the user set. When KVMD starts and finishes, all output ports are reset to 0. This can be avoided using the `initial` parameter. Two interaction modes are available for outputs: `pulse` and `switch`. In pulse mode, the output quickly switches its state to logical 1 and back (just like a button). In switch mode, it saves the state that the user set. When KVMD starts and finishes, all output ports are reset to 0. This can be avoided using the `initial` parameter.
If no driver is specified for the port in the scheme, `__gpio__` will be used as default. If no driver is specified for the port in the scheme, `__gpio__` will be used as default.
```yaml ```yaml
kvmd: kvmd:
gpio: gpio:
scheme: scheme:
# A certain device sends signals to the RPi and we want the Pi-KVM to display this as an led # A certain device sends signals to the RPi and we want the Pi-KVM to display this as an led
@ -72,12 +74,13 @@ Setting up GPIO is quite complex. The interface is divided into several layers f
pulse: pulse:
delay: 2 # Default pulse value delay: 2 # Default pulse value
max_delay: 2 # The pulse interval can be between min_pulse (0.1 by default) and max_pulse=5 max_delay: 2 # The pulse interval can be between min_pulse (0.1 by default) and max_pulse=5
``` ```
* **View** is the visualization layer of the scheme. It describes what the menu with GPIO functions will look like. It is easier to show by example. ### View
This is the last layer of the scheme. It describes what the menu with GPIO functions will look like. It is easier to show by example.
```yaml ```yaml
kvmd: kvmd:
gpio: gpio:
view: view:
header: header:
@ -92,16 +95,16 @@ Setting up GPIO is quite complex. The interface is divided into several layers f
- [] - []
- ["#Relay #1:", "relay1,Boop 0.1"] # Text label and button with alternative text - ["#Relay #1:", "relay1,Boop 0.1"] # Text label and button with alternative text
- ["#Relay #2:", "relay2,Boop 2.0"] - ["#Relay #2:", "relay2,Boop 2.0"]
``` ```
This will be rendered as: This will be rendered as:
<img src="../img/gpio_menu.png" alt="drawing" /> <img src="../img/gpio_menu.png" alt="drawing" />
Here the rules: Here the rules:
- Text starting with the `#` symbol will be a label. - Text starting with the `#` symbol will be a label.
- To place a port in a cell, just put its name from the scheme. - To place a port in a cell, just put its name from the scheme.
- The inputs are displayed as round LEDs. - The inputs are displayed as round LEDs.
- The outputs are displayed as a switch AND a button. - The outputs are displayed as a switch AND a button.
- If the switch mode is disabled, only a button will be displayed. If pulse is disabled, only a switch will be shown. - If the switch mode is disabled, only a button will be displayed. If pulse is disabled, only a switch will be shown.
- To rename the output button, write some its identifier using comma like `"relay1,My cool relay"`. - To rename the output button, write some its identifier using comma like `"relay1,My cool relay"`.