This beagleboard module implements a BeagleBoard BeagleBone AI 64 using the rdk:component:board
API.
Follow the setup guide to prepare your BeagleBone for running viam-server
before configuring a beaglebone
board.
Note
Before configuring your board, you must create a machine.
Navigate to the CONFIGURE tab of your machine in the Viam app. Add board / beagleboard:beaglebone to your machine.
The following attributes are available for viam:beagleboard:beaglebone
boards:
Attribute | Type | Required? | Description |
---|---|---|---|
digital_interrupts |
object | Optional | Any digital interrupts's pin number and name. |
For instructions on implementing digital interrupts, see Digital interrupt configuration.
{
"name": "<your-beagleboard-beaglebone-board-name>",
"model": "viam:beagleboard:beaglebone",
"type": "board",
"namespace": "rdk",
"attributes": {
},
"depends_on": []
}
- To test your board, expand the TEST section of its configuration pane or go to the CONTROL tab.
- To write code against your board, use one of the available SDKs.
- To view examples using a board component, explore these tutorials.
Interrupts are a method of signaling precise state changes. Configuring digital interrupts to monitor GPIO pins on your board is useful when your application needs to know precisely when there is a change in GPIO value between high and low.
- When an interrupt configured on your board processes a change in the state of the GPIO pin it is configured to monitor, it ticks to record the state change.
You can stream these ticks with the board API's
StreamTicks()
, or get the current value of the digital interrupt withValue()
. - Calling
GetGPIO()
on a GPIO pin, which you can do without configuring interrupts, is useful when you want to know a pin's value at specific points in your program, but is less precise and convenient than using an interrupt.
Integrate digital_interrupts
into your machine in the attributes
of your board by adding the following to your board's attributes
configuration:
{
"digital_interrupts": [
{
"name": "<your-digital-interrupt-name>",
"pin": "<your-digital-interrupt-pin-number>"
}
]
}
The following attributes are available for digital_interrupts
:
Name | Type | Required? | Description |
---|---|---|---|
name |
string | Required | Your name for the digital interrupt. |
pin |
string | Required | The pin number of the board's GPIO pin that you wish to configure the digital interrupt for. |
{
"components": [
{
"name": "<your-beagleboard-beaglebone-board-name>",
"model": "viam:beagleboard:beaglebone",
"type": "board",
"namespace": "rdk",
"attributes": {
"digital_interrupts": [
{
"name": "your-interrupt-1",
"pin": "15"
},
{
"name": "your-interrupt-2",
"pin": "16"
}
]
}
}
]
}