About the connector
BerryIO – a Browser Based IO Control System for Raspberry Pi. In a nutshell, BerryIO is a web browser based IO control system for the Raspberry Pi.
This document provides information about the BerryIO connector, which facilitates automated interactions with BerryIO using FortiSOAR™ playbooks. Add the BerryIO connector as a step in FortiSOAR™ playbooks and perform automated operations, such as setting a mode of a specified GPIO pin, or retrieving the status of all GPIO pins.
Version information
Connector Version: 1.0.1
Authored By: Fortinet
Certified: No
Release Notes for version 1.0.1
Following enhancements have been made to the BerryIO connector in version 1.0.1:
- Updated the connector logo of the BerryIO connector.
Installing the connector
All connectors provided by FortiSOAR™ are delivered using a FortiSOAR™ repository. Therefore, you must set up your FortiSOAR™ repository and use the yum command to install connectors:
yum install cyops-connector-berryio
For the detailed procedure to install a connector, click here
Prerequisites to configuring the connector
- You must have the URL of BerryIO server to which you will connect and perform automated operations and credentials to access that server.
- To access the FortiSOAR™ UI, ensure that port 443 is open through the firewall for the FortiSOAR™ instance.
Configuring the connector
For the procedure to configure a connector, click here
Configuration parameters
In FortiSOAR™, on the connectors page, select the BerryIO connector and click Configure to configure the following parameters:
| Parameter |
Description |
| Server URL |
URL of the BerryIO server to which you will connect and perform automated operations. |
| Username |
Username to access the BerryIO server to which you will connect and perform the automated operations. |
| Password |
Password to access the BerryIO server to which you will connect and perform the automated operations. |
| Verify SSL |
Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True. |
Actions supported by the connector
The following automated operations can be included in playbooks, and you can also use the annotations to access operations from CyOPsTM release 4.10.0 and onwards:
| Function |
Description |
Annotation and Category |
| Get GPIO Pin Status |
Return the status of all the GPIO pins. |
get_gpio
Investigation |
| Set GPIO Pin Mode |
Set the mode of a given GPIO pin. |
set_gpio_mode
Miscellaneous |
| Set GPIO Pin Value |
Set the value of a given GPIO pin. |
set_gpio_value
Miscellaneous |
operation: Get GPIO Pin Status
Input parameters
None.
Output
The output contains the following populated JSON schema:
{
"result": {},
"request_status": ""
}
operation: Set GPIO Pin Mode
Input parameters
| Parameter |
Description |
| Pin |
The GPIO pin whose mode needs to be set. |
| Mode |
The mode that needs to be set to the GPIO pin. |
Output
The output contains the following populated JSON schema:
{
"result": {},
"request_status": ""
}
operation: Set GPIO Pin Value
Input parameters
| Parameter |
Description |
| Pin |
The GPIO pin whose value needs to be to set. |
| Value |
The value that needs to be set to the GPIO pin. |
Output
The output contains the following populated JSON schema:
{
"result": {},
"request_status": ""
}
Included playbooks
The Sample - BerryIO - 1.0.1 playbook collection comes bundled with the BerryIO connector. These playbooks contain steps using which you can perform all supported actions. You can see bundled playbooks in the Automation > Playbooks section in CyOPsTM after importing the BerryIO connector.
- Get GPIO Pin Status
- Set GPIO Pin Mode
- Set GPIO Pin Value
Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection since the sample playbook collection gets deleted during connector upgrade and delete.
