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:

• kernel_commands
• plugin_core_commands

bus.mode.stream

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.buffered-command

Functionality to be advised.

commands.get_all

Supports the get all command to list all variables and their values.

Variables

• all

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

• help

dms

Variables

• dms.auto_start_enabled

APIs

• gos_dms_set_message_fallback_handler
• gos_dms_set_message_stream_state_handler
• gos_dms_message_write_buffer
• gos_dms_message_write_init
• gos_dms_message_write_raw
• gos_dms_message_write_flush
• gos_dms_message_context_destroy
• gos_dms_message_register_action_listener
• gos_dms_message_unregister_action_listener

dms.command_console

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

Variables

• dms.cmd.enabled

dms.telemetry

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

Commands

• dms_telemetry

Variables

• dms.telemetry.adc_mask
• dms.telemetry.data_mask
• dms.telemetry.gpio_mask
• dms.telemetry.interval

APIs

• gos_dms_set_telemetry_callback
• gos_dms_post_telemetry

file_system

Supports flash file management.

Commands

• file_create
• file_open
• file_stat

file_system.log_files

APIs

• gos_log_file_open
• gos_log_file_append
• gos_log_file_read
• gos_log_file_get_stats

kernel_commands

Commands

• dfu_query
• dfu_request
• dfu_response
• dfu_update
• dms_activate
• dms_claim
• factory_reset
• faults_print
• faults_reset
• file_delete
• format_flash
• get
• ls
• reboot
• save
• set
• validate_creds
• version

Variables

• app.debug.auto_run
• bus.data_bus
• bus.log_bus
• bus.mode
• dfu.logs_enabled
• dms.connection.port
• dms.connection.timeout
• dms.interface
• ethernet.dhcp.enabled
• ethernet.dhcp.timeout
• ethernet.link_detected_timeout
• ethernet.link_local.enabled
• ethernet.link_local.timeout
• ethernet.static.dns
• ethernet.static.gateway
• ethernet.static.ip
• ethernet.static.netmask
• system.bflash.cs_gpio
• system.bflash.port
• system.cmd.buffered
• system.cmd.echo
• system.cmd.format
• system.cmd.gpio
• system.cmd.header_enabled
• system.cmd.prompt_enabled
• system.cmd.timestamp
• system.debug.coredump_enabled
• system.factory_reset.gpio
• system.factory_reset.level
• system.hfxo.enabled
• system.interface.ethernet_enabled
• system.interface.wifi_enabled
• system.print_level
• system.safemode.console_timeout
• system.safemode.disabled
• system.safemode.ota_auto_retry
• system.safemode.sleep_timeout
• system.security_key
• system.variable_lock
• 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.link_local.enabled
• wlan.link_local.timeout
• wlan.passkey
• wlan.rate.protocol
• wlan.rate.transmit
• 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
• dfu.status
• dms.bundle_id
• dms.connection.host
• dms.product_id
• ethernet.mac
• ethernet.network.dns
• ethernet.network.gateway
• ethernet.network.ip
• ethernet.network.netmask
• ethernet.network.status
• system.bootloader.fsb_version
• system.bootloader.ssb_version
• system.build_number
• system.hfxo.status
• system.safemode.status
• system.uuid
• system.version
• wlan.mac
• wlan.network.dns
• wlan.network.gateway
• wlan.network.ip
• wlan.network.netmask
• wlan.network.status

network.commands

Supports WLAN and Soft AP network features.

Commands

• network_down
• network_flush
• network_lookup
• network_restart
• network_up
• network_verify
• ping
• wlan_scan

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.ca_cert_verify_enabled
• network.tls.client_cert
• network.tls.client_key
• network.tls.handshake_timeout
• network.tls.version

network.dhcp_cache

network.interface.ethernet

Variables

• ethernet.auto_start.enabled
• ethernet.auto_start.retry_delay
• ethernet.dhcp.hostname
• ethernet.multicast.address
• ethernet.network.status_gpio

network.interface.ethernet.dhcp_cache

Variables

• ethernet.dhcp.cache_enabled

network.interface.softap

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

Variables

• softap.auto_start
• softap.captive_portal_enabled
• 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.mac
• softap.max_clients
• softap.passkey
• softap.ssid
• softap.static.gateway
• softap.static.ip
• softap.static.netmask

APIs

• gos_network_softap_client_list
• gos_network_register_softap_event_handler
• gos_network_set_softap_domain_list

network.interface.wlan

Supports the WLAN network interface.

Variables

• wlan.auto_join.enabled
• wlan.auto_join.retries
• wlan.auto_join.retry_delay
• wlan.coex.mode
• wlan.dhcp.hostname
• wlan.info
• wlan.join.result
• wlan.multicast.address
• wlan.network.status_gpio
• wlan.powersave.listen_interval
• wlan.powersave.mode

APIs

• gos_network_get_wlan_join_result

network.interface.wlan.dhcp_cache

Variables

• wlan.dhcp.cache_enabled

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

• broadcast.data
• broadcast.interface
• broadcast.interval
• broadcast.udp.ip
• broadcast.udp.local_port
• broadcast.udp.remote_port

APIs

• gos_broadcast_set_callback

network.periodic_broadcast.http

Supports periodic broadcast of data as an HTTP(S) POST request.

Variables

• broadcast.http.host

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

Supports network RSSI averaging.

network.rssi_averager.softap

Supports network RSSI averaging for the Soft AP interface.

Commands

• softap_get_rssi

Variables

• softap.rssi_average

APIs

• gos_network_softap_get_rssi

network.rssi_averager.wlan

Supports network RSSI averaging for the WLAN interface.

Commands

• wlan_get_rssi

Variables

• wlan.rssi_average

APIs

• gos_network_get_rssi

peripheral.adc

Supports Analog to Digital Converters (ADCs).

Commands

• adc_take_sample

Variables

• system.adc.vref

APIs

• gos_adc_prepare_lut
• gos_adc_destroy_lut

peripheral.dac

Supports Digital to Analog Converters (DACs).

Commands

• dac_set_level

peripheral.gpio.alias

Supports assigning aliases to GPIOs.

Variables

• gpio.alias

peripheral.gpio.commands

Supports GPIO configuration commands.

Commands

• gpio_dir
• gpio_get
• gpio_set
• gpios_dir
• gpios_get
• gpios_set

Variables

• gpio.usage

peripheral.gpio.init_direction

Supports GPIO initialization.

Variables

• gpio.init

peripheral.gpio.sleep

Supports setting the state of GPIOs when sleeping.

Variables

• gpio.sleep

peripheral.i2c_master

Supports I2C master.

Commands

• i2c_master_config
• i2c_master_open

APIs

• gos_i2c_stream_configure
• gos_i2c_stream_set_slave_address

peripheral.pwm

Commands

• pwm_update

APIs

• gos_pwm_update
• gos_pwm_stop

peripheral.spi_master

Supports SPI master.

Commands

• spi_master_config
• spi_master_open

Variables

• spi.master.active_gpio
• spi.master.active_level

APIs

• gos_spi_stream_configure
• gos_spi_stream_set_slave_select

peripheral.uart.commands

Supports UART configuration commands.

Commands

• uart_update

plugin_core_commands

Commands

• exit
• force_safemode

Variables

• app.debug.ignore_settings
• app.info
• bus.command.read_timeout
• bus.command.rx_bufsize
• bus.command.write_check_enabled
• bus.command.write_timeout
• system.cmd.aux_bus
• system.memory.usage
• system.powersave.mode

protocols.bonjour

Variables

• mdns.enabled
• mdns.interface
• mdns.name
• mdns.service
• mdns.ttl

protocols.http.client

Supports HTTP Client functions.

Commands

• http_add_header
• http_get
• http_head
• http_post
• http_read_status

Variables

• http.client.retries
• http.client.retry_period

protocols.http.file_transfer

Supports HTTP file transfer, with upload and download.

Commands

• http_download
• http_upload

APIs

• gos_http_download

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_peer_cert
• http.server.tls_verify_peer
• http.server.username

APIs

• gos_hs_register_dynamic_page
• gos_hs_register_header_callback
• gos_hs_register_authorize_callback
• gos_hs_register_not_found_callback
• gos_hs_get_tls_client_list
• gos_hs_register_keepalive_connection_opened_callback
• gos_hs_register_keepalive_connection_closed_callback
• gos_hs_register_event_processing_callback
• gos_hs_register_direct_receive_callback
• gos_hs_trigger_processing_event

protocols.http.server.command.rest_api

Variables

• http.server.api_enabled

protocols.http.server.command.ws_api

APIs

• gos_hs_issue_ws_api_event

protocols.http.server.data_api

APIs

• gos_hs_stream_register
• gos_hs_stream_unregister
• gos_hs_stream_flush
• gos_hs_stream_write_direct
• gos_hs_stream_ws_list
• gos_hs_stream_ws_read
• gos_hs_stream_ws_write
• gos_hs_stream_ws_abort_write
• gos_hs_stream_ws_close
• gos_hs_stream_ws_set_accept_callback
• gos_hs_stream_ws_set_handlers

protocols.http.server.keepalive

Variables

• http.server.keep_alive_enabled
• http.server.keep_alive_timeout

APIs

• gos_hs_write_async_data
• gos_hs_close_keepalive_connection

protocols.ntp

Variables

• ntp.enabled
• ntp.interface
• ntp.interval
• ntp.server

APIs

• gos_ntp_update

protocols.smtp

Supports Simple Mail Transfer Protocol (SMTP).

Commands

• smtp_send

Variables

• email.name_address
• email.smtp.host
• email.smtp.password
• email.smtp.port
• email.smtp.username

APIs

• gos_smtp_send_with_config

protocols.tcp.client

Supports TCP Client features.

Commands

• tcp_client
• tls_client

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

• tcp_server
• tls_server

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_peer_cert
• tcp.server.tls_verify_peer

APIs

• gos_tcp_register_server_event_handlers
• gos_tcp_trigger_server_event_handlers

protocols.udp.client

Supports UDP Client features.

Commands

• udp_client

Variables

• udp.client.auto_interface
• udp.client.auto_retry
• udp.client.auto_start
• udp.client.local_port
• udp.client.remote_host
• udp.client.remote_port

protocols.udp.server

Supports UDP Server features.

APIs

• gos_udp_query
• gos_udp_sendto
• gos_udp_receivefrom

protocols.udp.server.stream

Supports UDP Server stream features.

Commands

• udp_server

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

• websocket_client

APIs

• gos_websocket_client_read_frame

protocols.websocket.server

Supports Websocket Server features.

Variables

• http.server.ws_connected_gpio
• http.server.ws_data_gpio

APIs

• gos_websocket_register_server_event_handlers

sdk_app.thread

APIs

• gos_event_enable_irq_events
• gos_event_disable_irq_events
• gos_event_irq_events_enabled

settings.file_load

Supports loading a configuration file containing variable settings.

Commands

• load

APIs

• gos_settings_load_from_file

settings.file_save

Supports saving a configuration file containing variable settings.

APIs

• gos_settings_save_to_file

setup.cmd

Commands

• setup_cmd

setup.device

Commands

• setup_device

setup.gpio

Supports initiating the setup command using a GPIO.

Variables

• setup.auto.cmd
• setup.gpio.cmd
• setup.gpio.control_gpio
• setup.gpio.level
• setup.gpio.mode

setup.web

Supports using the Gecko OS Web App for setup.

Commands

• setup_web

Variables

• setup.web.captive_portal_enabled
• setup.web.client_list
• setup.web.idle_timeout
• setup.web.passkey
• setup.web.root_filename
• setup.web.ssid
• setup.web.url

APIs

• gos_setup_start
• gos_setup_stop
• gos_setup_register_client_event_handler
• gos_setup_register_finished_event_handler
• gos_setup_get_client_os_str

stream_mgr

Supports stream management commands.

Commands

• stream_close
• stream_list
• stream_poll
• stream_read
• stream_write

Variables

• stream.auto_close

APIs

• gos_close
• gos_poll
• gos_file_close
• gos_network_close_all_streams
• gos_i2c_stream_close
• gos_spi_stream_close
• gos_http_poll
• gos_tcp_disconnect
• gos_tcp_poll
• gos_udp_close
• gos_udp_poll
• gos_websocket_disconnect
• gos_websocket_poll

system.activity

Supports system activity GPIO functionality.

Variables

• system.activity.gpio
• system.activity.gpio_level

system.indicator

Supports system indicator GPIO functionality.

Variables

• system.indicator.gpio
• system.indicator.state

system.memory_profile

Supports the memory profiling feature.

Commands

• mp_start
• mp_stop

system.message

Supports customizing system messages.

Variables

• system.msg

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
• pu_stop

system.time

Supports system time features. See also NTP.

Variables

• time.last_set
• time.rtc
• time.uptime
• time.zone

APIs

• gos_time_set_timezone_offset

test.null_socket

Variables

• nsocket.enabled
• nsocket.rx.delay
• nsocket.rx.random_delay_enabled
• nsocket.rx.validate_enabled

test.wifi_cert

Commands

• testmode
• testmode_sleep

Variables

• testmode.channel
• testmode.coex.mode
• testmode.cw.freq1
• testmode.cw.freq2
• testmode.cw.mode
• testmode.cw.tx_power
• testmode.hfxo.ctune_fix
• testmode.hfxo.ctune_xi
• testmode.hfxo.ctune_xo
• testmode.hfxo.temp_comp
• testmode.mode
• testmode.period
• testmode.protocol
• testmode.rate
• testmode.tx.ht_format
• testmode.tx.ifs
• testmode.tx.length
• testmode.tx.number
• testmode.tx.output_power