FAQs
- This command resets the BB-400 to default/factory settings.
- The
bb resetcommand requires root access. The user needs to be signed in as root user or use thesudokeyword to run this command. - This command takes about 2 minutes to run. If the command executed successfully then the following message will be returned:
bb@bb400-00b0:~ $ sudo bb reset
{
'message': 'Finished reset',
'success': true
}These are the factory defaults the device will be set to:
################################################################################
# Brainboxes Configuration File
################################################################################
# This file is generated after a successful image flash
# It contains information about the version and unit configuration
# This file is read on device boot up, the settings are then applied to the various device interfaces (if configurable)
# The brainboxes web admin interfaces reads and writes data to this file
# The file can also be edited manually, the file is watched during the running of the device, if a change is detected the new settings will take effect
# Please note some settings may take a minute to take effect,
# Also note some settings may not be possible
# If any setting errors occur they are written the to log file located: varlogbrainboxesbb_cli.log
# This file can also be interacted with through the BB-CLI on the command line just type:
# bb config
# the whole file will be returned on the command line to view a portion of the file simply navigate to the path you are interested in e.g:
# bb config.network.eth0.connection.type
# > dhcp
# to edit a value simply write it after the path e.g to edit eth0 type from dhcp to static:
# bb config.network.eth0.connection.type static
# {
# "message": "1. config.network.eth0 - Value updated",
# "success": true
#}
# command line will respond with the output of the command
version:
product: BB-400
hardware: r3
software: 1.0.963
# The part number of the product
# Hardware revision/version
# Version of the Brainboxes software
io:
# These are settings which apply to the 8 IO lines and the BB-IO-Server which interfaces with the IO lines
fw_version: 1.0.10
global:
counter_update_direction: falling_edge
counter_mode: 16_bit_counter
# The Arduino or DIO firmware version number
# IO lines configuration settings apply to all IO lines
# Counter update - Falling Edge or Rising Edge in the input signal
# Input Counter Mode can be 16-bit or 32-bit, this is the size of the register
# To store the count value 16-bit = 0 > 65,536 / 32-bit = 0 > 4,294,967,296
lines:
dio0:
label: dio0
mode: not_set
debounce: 0
dio1:
label: dio1
mode: not_set
debounce: 0
dio2:
label: dio2
mode: not_set
debounce: 0
dio3:
label: dio3
mode: not_set
debounce: 0
dio4:
label: dio4
mode: not_set
debounce: 0
dio5:
label: dio5
mode: not_set
debounce: 0
dio6:
label: dio6
mode: not_set
debounce: 0
dio7:
label: dio7
mode: not_set
debounce: 0
# User defined label for the DIO lines
# Input or Output or Not_set or Unused
# Whether the line is used as an Input, an Output or ?
# Debounce time in milliseconds, valid input should be between 0 & 4000
protocols:
polling_interval: 1
virtual_serial_port:
enabled: true
path: /usr/share/brainboxes/virtual_serial_port
# This section covers the different protocols which is used by the BB-IO-Server
# Set the polling interval in seconds to get the DIO line states
# Virtual COM port accessible by a program running on the BB-400
# Enable status - True or False
# symlink to the generated virtual serial port
ascii_tcp:
enabled: true
port: 9500
# ASCII TCP server conforms to the ASCII TCP protocol as on Brainboxes Digital Remote IO modules ED-008 or ED-588.
# For more info see: http://www.brainboxes.com/faq/items/ascii-protocol-and-commands
# Enabled status - Whether to enable the server - True or False
# Port number the server runs on
modbus_tcp:
enabled: true
port: 502
respond_to_slave_ids: 0 to 255
accept_all_addresses: false
maximum_connections: 8
idle_timeout: 0
# The Modbus TCP server conforms to the Modbus TCP protocol as on Brainboxes Digital IO modules ED-588 or ED-008.
# Enabled status - Whether to enable the server - True or False
# Port number the server runs on
rest_server:
enabled: true
port: 9000
# REST server allows GET and POST requests to view and modify IO state
ws_server:
enabled: true
port: 8989
# WebSocket server pushes new IO state to the clients and receives requests to change state, uses a JSON payload
network:
eth0: # Interface name
interface:
mac: 00:0a:4f:xx:xx:xx
status: active
# MAC address of ethernet (eth0), xx - will be replaced by the device MAC address
# Ethernet status - active or inactive
connection:
name: BB-WAN
type: dhcp
# Name of the connection
# IP address assignment type - static or DHCP
eth1: # Interface name
interface:
mac: 00:0a:4f:xx:xx:xx
status: active
# MAC address of ethernet (eth1), xx - will be replaced by the device MAC address
# Ethernet status - active or inactive
connection:
name: BB-LAN
type: static
ip: 192.168.127.1/24
gateway: 0.0.0.0
# Name of the connection
# IP address assignment type - static or DHCP
# IP address, if type is static
# Gateway IP address, if type is static
radio:
base_mac_address: 00:0a:4f:xx:xx:xx # xx - will be replaced by the device MAC address
wlan0: # wireless lan client, only available in radio.co_exist 3 or 14
interface:
status: inactive
connections: []
wifiap: # wireless lan hotspot, only available in radio.coexist_mode 3 or 13
interface:
status: active
connection:
ssid: bb-400-xxxx # xxxx will be replaced by the last 4 characters of the MAC address
ip: 192.168.63.1/24
bluetooth: # bt, only available in radio.coexist_mode 13 or 14
interface:
status: inactive
upnp: # upnp is used to discover device on a windows network
enabled: true # Enable status - whether UPnP is enabled or disabled, vlid inputs are true and false
port: 5001 # Port number the UPnP server will run on
serial: # this section covers the serial port settings on the BB-400
enabled: true # If serial port is enabled or disabled
type: rs232 # this port is available on the device as /dev/ttySC0
default: # serial port settings
ignore_application: false # whether these settings should override application settings
baud_rate: 115200
data_bits: 8
stop_bits: 1
parity: none
flow_control: none
protocol:
type: telnet
port: 9001
timeout: 0
tunneling:
enabled: false
remote_ip: 192.168.0.0
remote_port: 9001
docker:
enabled: true
containers: []
system:
rtc: false # the last datetime that the rtc was set in format ISO 8601
hostname: bb400-xxxx # host name of the device, will be replaced by last 4 characters of the MAC address
timezone: UTC # timezone of device
username: bb
password: '****' # passwords are never stored in the config file once they are set, instead '****' is used as a placeholder to show the user that this property is set FAQs
