Gecko OS Plugins

This page shows commands variables, and APIs for the kernel and each Gecko OS plugin.

For commands and variable always available with the kernel, see:

bus.mode.stream

Variables

commands.advanced_console

Functionality to be advised.

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

Variables

APIs

dms.command_console

Supports issuing commands to the device remotely from the DMS console.

Variables

dms.telemetry

Supports DMS telemetry - uploading device parameters and sensor values to the DMS, for possible cloud distribution.

Commands

Variables

APIs

file_system

Supports flash file management.

Commands

file_system.log_files

APIs

kernel_commands

Commands

Variables

network.commands

Supports WLAN and Soft AP network features.

Commands

Variables

network.dhcp_cache

network.interface.ethernet

Variables

network.interface.ethernet.dhcp_cache

Variables

network.interface.softap

Supports the Soft Access Point (Soft AP) network interface.

Variables

APIs

network.interface.wlan

Supports the WLAN network interface.

Variables

APIs

network.interface.wlan.dhcp_cache

Variables

network.ioconn

Supports using a GPIO for automated network connection.

Variables

network.periodic_broadcast

Supports network broadcast of specified device parameters.

Variables

APIs

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

network.rssi_averager

Supports network RSSI averaging.

network.rssi_averager.softap

Supports network RSSI averaging for the Soft AP interface.

Commands

Variables

APIs

network.rssi_averager.wlan

Supports network RSSI averaging for the WLAN interface.

Commands

Variables

APIs

peripheral.adc

Supports Analog to Digital Converters (ADCs).

Commands

Variables

APIs

peripheral.dac

Supports Digital to Analog Converters (DACs).

Commands

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

APIs

peripheral.pwm

Commands

APIs

peripheral.spi_master

Supports SPI master.

Commands

Variables

APIs

peripheral.uart.commands

Supports UART configuration commands.

Commands

plugin_core_commands

Commands

Variables

protocols.bonjour

Variables

protocols.http.client

Supports HTTP Client functions.

Commands

Variables

protocols.http.file_transfer

Supports HTTP file transfer, with upload and download.

Commands

APIs

protocols.http.server

Supports HTTP Server features.

Variables

APIs

protocols.http.server.command.rest_api

Variables

protocols.http.server.command.ws_api

APIs

protocols.http.server.data_api

APIs

protocols.http.server.keepalive

Variables

APIs

protocols.ntp

Variables

APIs

protocols.smtp

Supports Simple Mail Transfer Protocol (SMTP).

Commands

Variables

APIs

protocols.tcp.client

Supports TCP Client features.

Commands

Variables

protocols.tcp.keepalive

Supports the TCP keepalive feature.

Variables

protocols.tcp.server

Supports TCP Server features.

protocols.tcp.server.stream

Supports TCP Server stream features.

Commands

Variables

APIs

protocols.udp.client

Supports UDP Client features.

Commands

Variables

protocols.udp.server

Supports UDP Server features.

APIs

protocols.udp.server.stream

Supports UDP Server stream features.

Commands

Variables

protocols.websocket.client

Supports Websocket Client features.

Commands

APIs

protocols.websocket.server

Supports Websocket Server features.

Variables

APIs

sdk_app.thread

APIs

settings.file_load

Supports loading a configuration file containing variable settings.

Commands

APIs

settings.file_save

Supports saving a configuration file containing variable settings.

APIs

setup.cmd

Commands

setup.device

Commands

setup.gpio

Supports initiating the setup command using a GPIO.

Variables

setup.web

Supports using the Gecko OS Web App for setup.

Commands

Variables

APIs

stream_mgr

Supports stream management commands.

Commands

Variables

APIs

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

system.message

Supports customizing system messages.

Variables

system.oob_gpio

Supports Out-Of-Band (OOB) Interrupts.

Variables

system.processor_usage

Supports processor usage functionality.

Commands

system.time

Supports system time features. See also NTP.

Variables

APIs

test.null_socket

Variables

test.wifi_cert

Commands

Variables