GeckoOS Kernel Plugins
Kernel
The following commands and variables are always available in the Kernel.
Commands
- ?
- app.debug.auto_run
- dms_activate
- dms_claim
- exit
- factory_reset
- faults_print
- faults_reset
- force_safemode
- format_flash
- get
- ls
- ota
- pwm_update
- reboot
- save
- set
- uart_update
- version
Variables
- bus.command.read_timeout
- bus.command.rx_bufsize
- bus.command.write_check_enabled
- bus.command.write_timeout
- bus.data_bus
- bus.log_bus
- bus.mode
- dms.bundle_id
- softap.captive_portal_enabled
- spi.master.active_gpio
- spi.master.active_level
- system.adc.vref
- system.bflash.cs_gpio
- system.build_number
- system.cmd.aux_bus
- system.cmd.buffered
- system.cmd.echo
- system.cmd.format
- system.cmd.gpio
- system.cmd.header_enabled
- system.cmd.prompt_enabled
- system.cmd.timestamp
- system.factory_reset.aux_gpio
- system.factory_reset.aux_level
- system.memory.usage
- system.powersave.mode
- system.print_level
- system.safemode.disabled
- system.safemode.status
- system.security_key
- system.uuid
- system.variable_lock
- system.version
- tcp.client.connect_timeout
- tcp.client.local_port
- tcp.client.retries
- tcp.client.retry_period
- uart.baud
- uart.data
- uart.flow
- uart.parity
- uart.stop
- wlan.antenna.select
- wlan.bssid
- wlan.dhcp.enabled
- wlan.dhcp.timeout
- wlan.hide_passkey
- wlan.join.retries
- wlan.join.timeout
- wlan.mac
- wlan.network.dns
- wlan.network.gateway
- wlan.network.ip
- wlan.network.netmask
- wlan.network.status
- wlan.passkey
- wlan.rate.protocol
- wlan.rate.transmit
- wlan.region
- wlan.roam.threshold
- wlan.scan.active_dwell
- wlan.scan.channel_mask
- wlan.scan.home_dwell
- wlan.scan.num_probes
- wlan.scan.passive_dwell
- wlan.scan.retries
- wlan.scan.type
- wlan.security
- wlan.ssid
- wlan.static.dns
- wlan.static.gateway
- wlan.static.ip
- wlan.static.netmask
- wlan.tx_power
bus.mode.stream
Supports STREAM mode. See Serial Interface, Stream Mode.
Variables
- bus.stream.cmd_gpio
- bus.stream.cmd_seq
- bus.stream.flush_count
- bus.stream.flush_time
- bus.stream.flush_time_reset
commands.advanced_console
Functionality to be advised
commands.aux_console
Functionality to be advised.
Variables
system.cmd.aux_console
- Not yet available
commands.buffered-command
Functionality to be advised.
commands.get_all
Supports the get all
command to list all variables and their values.
Variables
commands.group_getter
Functionality to be advised.
commands.help
Supports the help command, which lists available commands and variables, and shows links to online documentation.
Commands
dms.stream
Functionality to be advised.
file_system
Supports flash file management.
Commands
network.commands
Supports WLAN and Soft AP network features.
Commands
Variables
- network.arp.lock_enabled
- network.arp.table_size
- network.buffer.control_size
- network.buffer.rxtx_ratio
- network.buffer.size
- network.buffer.usage
- network.default_interface
- network.dns.timeout
- network.tcp.delivery_type
- network.tls.ca_cert
- network.tls.client_cert
- network.tls.client_key
- network.tls.version
network.interface.softap
Supports the Soft Access Point (Soft AP) network interface.
Variables
- softap.auto_start
- softap.channel
- softap.client_list
- softap.dhcp_server.enabled
- softap.dhcp_server.lease_time
- softap.dns_server.enabled
- softap.dns_server.url
- softap.hide_ssid
- softap.idle_timeout
- softap.info
- softap.max_clients
- softap.passkey
- softap.ssid
- softap.static.gateway
- softap.static.ip
- softap.static.netmask
network.interface.wlan
Supports the WLAN network interface.
Variables
- wlan.auto_join.enabled
- wlan.auto_join.retries
- wlan.auto_join.retry_delay
- wlan.dhcp.cache_enabled
- wlan.dhcp.hostname
- wlan.info
- wlan.join.result
- wlan.multicast.address
- wlan.network.status_gpio
- wlan.powersave.listen_interval
- wlan.powersave.mode
- wlan.powersave.sleep_delay
network.ioconn
Supports using a GPIO for automated network connection.
Variables
- ioconn.control_gpio
- ioconn.enabled
- ioconn.local_port
- ioconn.protocol
- ioconn.remote_host
- ioconn.remote_port
- ioconn.status_gpio
network.periodic_broadcast
Supports network broadcast of specified device parameters.
Variables
network.periodic_broadcast.http
Supports periodic broadcast of data as an HTTP(S) POST request.
Variables
network.remote_terminal
Supports the remote terminal console: issuing commands to the device via a network interface.
Variables
- remote_terminal.enabled
- remote_terminal.interface
- remote_terminal.password
- remote_terminal.port
- remote_terminal.timeout
network.rssi_averager
Support network RSSI averaging.
network.rssi_averager.softap
Support network RSSI averaging for the Soft AP.
Commands
Variables
network.rssi_averager.wlan
Commands
Variables
peripheral.adc
Supports Analog to Digital Converters (ADCs).
Commands
peripheral.dac
Supports Digital to Analog Converters (DACs).
Commands
dac_set_level
- Not yet available
peripheral.gpio.alias
Supports assigning aliases to GPIOs.
Variables
peripheral.gpio.commands
Supports GPIO configuration commands.
Commands
Variables
peripheral.gpio.init_direction
Supports GPIO initialization.
Variables
peripheral.gpio.sleep
Supports setting the state of GPIOs when sleeping.
Variables
peripheral.i2c_master
Supports I2C master.
Commands
peripheral.spi_master
Supports SPI master.
Commands
peripheral.uart.commands
Supports UART configuration commands.
protocols.http.client
Supports HTTP Client functions.
Commands
Variables
protocols.http.file_transfer
Supports HTTP file transfer, with upload and download.
Commands
protocols.http.server
Supports HTTP Server features.
Variables
- http.server.auth_title
- http.server.cors_origin
- http.server.denied_filename
- http.server.enabled
- http.server.interface
- http.server.max_clients
- http.server.notfound_filename
- http.server.password
- http.server.port
- http.server.root_filename
- http.server.tls_cert
- http.server.tls_client_log
- http.server.tls_enabled
- http.server.tls_key
- http.server.tls_log_clients
- http.server.tls_verify_peer
- http.server.username
protocols.http.server.command_stream
Supports HTTP Server command stream functionality.
protocols.http.server.rest_api
Supports the HTTP Server REST API.
Variables
protocols.http.server.rest_stream
Supports the HTTP Server REST stream keepalive feature.
Variables
http.server.keep_alive_enabled
- Not yet availablehttp.server.keep_alive_timeout
- Not yet available
protocols.mdns
Supports the MDNS feature.
Commands
Variables
protocols.ntp
Supports Network Time Protocol (NTP).
Variables
protocols.smtp
Supports Simple Mail Transfer Protocol (SMTP).
Commands
Variables
protocols.tcp.client
Supports TCP Client features.
Commands
Variables
- tcp.client.auto_interface
- tcp.client.auto_retries
- tcp.client.auto_start
- tcp.client.remote_host
- tcp.client.remote_port
- tcp.client.tls_enabled
protocols.tcp.keepalive
Supports the TCP keepalive feature.
Variables
- tcp.keepalive.enabled
- tcp.keepalive.initial_timeout
- tcp.keepalive.retry_count
- tcp.keepalive.retry_timeout
protocols.tcp.server
Supports TCP Server features.
protocols.tcp.server.stream
Supports TCP Server stream features.
Commands
Variables
- tcp.server.auto_interface
- tcp.server.auto_start
- tcp.server.connected_gpio
- tcp.server.data_gpio
- tcp.server.idle_timeout
- tcp.server.max_clients
- tcp.server.port
- tcp.server.tls_cert
- tcp.server.tls_enabled
- tcp.server.tls_key
- tcp.server.tls_verify_peer
protocols.udp.client
Supports UDP Client features.
Commands
Variables
- udp.client.auto_interface
- udp.client.auto_retry
- udp.client.auto_start
- udp.client.remote_host
- udp.client.remote_port
protocols.udp.server
Supports UDP Server features.
protocols.udp.server.stream
Supports UDP Server stream features.
Commands
Variables
- udp.server.auto_interface
- udp.server.auto_start
- udp.server.data_gpio
- udp.server.lock_client
- udp.server.port
- udp.server.remote_host
- udp.server.remote_port
protocols.websocket.client
Supports Websocket Client features.
Commands
protocols.websocket.server
Supports Websocket Server features.
Variables
settings.file_load
Supports loading a configuration file containing variable settings.
Commands
settings.file_save
Supports saving a configuration file containing variable settings.
setup.base
Supports the basic features of the setup command.
Commands
setup.gpio
Supports initiating the setup command using a GPIO.
Variables
setup.web
Supports using the Gecko OS Web App for setup.
Variables
- setup.web.client_list
- setup.web.idle_timeout
- setup.web.passkey
- setup.web.root_filename
- setup.web.ssid
- setup.web.url
stream_mgr
Supports stream management commands.
Commands
Variables
system.activity
Supports system activity GPIO functionality.
Variables
system.indicator
Supports system indicator GPIO functionality.
Variables
system.memory_profile
Supports the memory profiling feature.
Commands
mp_start
- Not yet availablemp_stop
- Not yet available
system.message
Supports customizing system messages.
Variables
system.oob_gpio
Supports Out-Of-Band (OOB) Interrupts.
Variables
- system.oob.event_mask
- system.oob.gpio
- system.oob.gpio_level
- system.oob.rising_edge_mask
- system.oob.status
system.processor_usage
Supports processor usage functionality.
Commands
pu_start
- Not yet availablepu_stop
- Not yet available
system.time
Supports system time features. See also NTP.
Variables
app.nvm
Supports ZAP Non-Volatile-Memory (NVM) features.
Commands
zap_set_ucfg
- Not yet available
app.thread
Supports ZAP thread features.