docs.zentri.com
docs.zentri.com
Search in:
docs
ZentriOS Wi-Fi SDK 3.0
Developing with ZentriOS
SDK Quickstart
ZentriOS Reference Guide
Overview
Developing with ZentriOS
Native API and SDK
ZentriOS API
Highlights
System & Core Libraries
Utilities
API Details
API Version
Access to Command APIs
Customizing the Command API
Dynamic HTTP URLs
Size Limits
File Size Limit
Hardware Support
Hardware Support Overview
Zentri AMW004
Zentri AMW106
NXP-SCCK
Additional Hardware
Zentri ASG001
InvenSense MPU-9250
Texas Instruments TCA6416A
Application Development
Features
API Overview
ZentriOS
ZentriOS API
ZentriOS SDK
ZentriOS Application
What is a ZentriOS Application?
Loading and Executing a Zap
Structure, Memory and Execution Contexts
Compiler
Optimization
Access to MCU Registers
ZentriOS App Structure
Zap Functions
zn_app_init
zn_app_deinit
zn_app_idle
Zap Operation
Example
Memory Sections
High Level Memory Sections
Zap Image
Code
Data
Memory Size by Platform
Optimizations
Execution Contexts
Context Attributes
Summary of Context Attributes
Available Contexts
Zap Thread
Network Thread
System Event Thread
HTTP Server Thread
Command Thread
Hardware IRQ
RTOS timer
Static Functions
HTTP Applications
Memory Constraints
Creating Timed Events
Using the Event API
Using the RTOS Timer API
Settings and Resources
Application Settings
Application Resources
Native API
Core
Memory
zn_free
zn_free_linked_list
zn_load_ro_memory
zn_malloc
zn_malloc_ptr
Commands
zn_issue_command
zn_issue_command_return_data
zn_issue_command_return_list_ptr
zn_issue_command_return_str
zn_issue_command_return_uint32
zn_issue_command_with_data
Data Streams
zn_close
zn_poll
zn_read
zn_read_with_buffer
zn_write
Debugging
Macros
ZOS_DUMP_ADD_SPACE
ZOS_DUMP_ENDIAN_BIG
ZOS_DUMP_ENDIAN_LITTLE
ZOS_DUMP_FLAGS
ZOS_DUMP_NO_ADDRESSES
ZOS_DUMP_NO_ASCII
ZOS_DUMP_NO_SPACE
ZOS_DUMP_PRINT_ADDRESSES
ZOS_DUMP_PRINT_ASCII
ZOS_DUMP_ROW_LEN_1
ZOS_DUMP_ROW_LEN_16
ZOS_DUMP_ROW_LEN_2
ZOS_DUMP_ROW_LEN_32
ZOS_DUMP_ROW_LEN_4
ZOS_DUMP_ROW_LEN_8
ZOS_DUMP_WORD_LEN_1
ZOS_DUMP_WORD_LEN_2
ZOS_DUMP_WORD_LEN_4
ZOS_ENABLE_JTAG_GPIOS
zn_dump_buffer
zn_log
zn_log_with_buffer
zn_vlog
Miscellaneous
Types
zos_buffer_t
data
size
zos_bool_t
zos_stream_event_handler_t
ZOS_FALSE
ZOS_TRUE
zos_app_flag_t
ZOS_APP_FLAG_NONE
ZOS_APP_FLAG_SLEEP_ON_EXIT
ZOS_APP_FLAG_DISABLE_CMD_CONSOLE
zos_app_priority_t
ZOS_APP_PRIORITY_HIGHEST
ZOS_APP_PRIORITY_HIGH
ZOS_APP_PRIORITY_MEDIUM
ZOS_APP_PRIORITY_LOW
ZOS_APP_PRIORITY_LOWEST
zos_app_type_t
ZOS_APP_TYPE_DAEMON
zos_result_t
ZOS_SUCCESS
ZOS_PENDING
ZOS_TIMEOUT
ZOS_ERROR
ZOS_INVALID_ARG
ZOS_UNSUPPORTED
ZOS_NOT_FOUND
ZOS_ABORTED
ZOS_NOT_CONNECTED
ZOS_INVALID_INTERFACE
ZOS_NO_MEM
ZOS_NULL_PTR
ZOS_UNINITIALIZED
ZOS_NEVER_SET
ZOS_SHUTTING_DOWN
ZOS_INVALID_HEADER
ZOS_SEMAPHORE_ERROR
ZOS_WAIT_ABORTED
ZOS_QUEUE_MESSAGE_UNALIGNED
ZOS_UNIMPLEMENTED
ZOS_CMD_SUCCESS
ZOS_CMD_FAILED
ZOS_CMD_PARSE_ERROR
ZOS_CMD_UNKNOWN
ZOS_CMD_TOO_FEW_ARGS
ZOS_CMD_TOO_MANY_ARGS
ZOS_CMD_UNKNOWN_OPTION
ZOS_CMD_BAD_ARGS
ZOS_CMD_BUFFER_OVERFLOW
ZOS_BUFFER_OVERFLOW
ZOS_DUPLICATE_EVENT
ZOS_BAD_EVENT_PERIOD
ZOS_NESTED_COMMAND
ZOS_NOT_SUBSCRIBED
ZOS_ZERO_LENGTH_BUFFER
ZOS_NO_DATA
ZOS_LOG_FILE_OVERFLOW
ZOS_INVALID_TOKEN
ZOS_WRITE_ERROR
Macros
ALIGN_4
ALIGN_8
ALIGN_n
ARRAY_COUNT
DEVICE_UUID_LEN
DIV_ROUND_UP
htonl
htons
MAX
MAX_STREAM_COUNT
MIN
ntohs
OFFSETOF
ROUND_UP
UNUSED_PARAMETER
URL_MAX_LENGTH
ZOS_CREATE_OBJECT
ZOS_DEBUG
ZOS_DESTROY_OBJECT
ZOS_FAILED
ZOS_INVALID_HANDLE
ZOS_LOG
ZOS_NEVER_TIMEOUT
ZOS_NO_WAIT
ZOS_VERIFY
ZOS_VLOG
ZOS_WAIT_FOREVER
Settings
ZentriOS Settings
zn_load_app_settings
zn_settings_get_print_str
zn_settings_get_str
zn_settings_get_uint32
zn_settings_load
zn_settings_save
zn_settings_set_int32
zn_settings_set_str
zn_settings_set_uint32
Application Settings
zn_nvm_get_cache_reference
zn_nvm_read
zn_nvm_save
zn_nvm_write
Macros
ZOS_GET_SETTING_STR
ZOS_NVM_GET_REF
ZOS_NVM_MAX_SIZE
ZOS_VERIFY_SETTING_STR
ZOS_VERIFY_SETTING_UINT32
Network
Interface
Types
zos_mac_t
octet
zos_ssid_t
len
val
zos_softap_client_t
additional
connected
ip_address
mac_address
zos_network_event_handler_t
zos_softap_event_handler_t
zos_deauth_reason_t
ZOS_DEAUTH_REASON_RESERVED
ZOS_DEAUTH_REASON_UNSPECIFIED
ZOS_DEAUTH_REASON_INACTIVITY
zos_interface_t
ZOS_WLAN
ZOS_SOFTAP
ZOS_ETHERNET
ZOS_CELLULAR
ZOS_DEFAULT_INTERFACE
ZOS_ANY_INTERFACE
Macros
ZOS_ANY_PORT
ZOS_MAC_ADDRESS_LEN
ZOS_MAX_SOFTAP_CLIENTS
zn_network_close_all_streams
zn_network_down
zn_network_is_up
zn_network_register_event_handler
zn_network_register_softap_event_handler
zn_network_restart
zn_network_softap_client_list
zn_network_softap_deauth_client
zn_network_up
Web Setup
Types
zos_setup_client_event_t
zos_setup_finished_event_t
setup_os_type_t
SETUP_OS_INVALID
SETUP_OS_UNKNOWN
SETUP_OS_WINDOWS
SETUP_OS_WINDOWS_MOBILE
SETUP_OS_ANDROID
SETUP_OS_LINUX
SETUP_OS_CHROME
SETUP_OS_IPHONE
SETUP_OS_IPOD
SETUP_OS_IPAD
SETUP_OS_MAC
SETUP_OS_BLACKBERRY
SETUP_OS_SYMBIAN
zn_setup_get_client_os_str
zn_setup_register_client_event_handler
zn_setup_register_finished_event_handler
zn_setup_start
zn_setup_stop
Utility
Types
zos_scan_result_t
band
bss_type
BSSID
channel
max_data_rate
next
on_channel
security
signal_strength
SSID
zos_tls_certificates_t
ca
cert
key
zos_802_11_band_t
ZOS_802_11_BAND_5GHZ
ZOS_802_11_BAND_2_4GHZ
zos_bss_type_t
ZOS_BSS_TYPE_INFRASTRUCTURE
ZOS_BSS_TYPE_ADHOC
ZOS_BSS_TYPE_ANY
ZOS_BSS_TYPE_UNKNOWN
zos_security_t
ZOS_SECURITY_OPEN
ZOS_SECURITY_WEP_PSK
ZOS_SECURITY_WEP_SHARED
ZOS_SECURITY_WPA_TKIP_PSK
ZOS_SECURITY_WPA_AES_PSK
ZOS_SECURITY_WPA2_AES_PSK
ZOS_SECURITY_WPA2_TKIP_PSK
ZOS_SECURITY_WPA2_MIXED_PSK
ZOS_SECURITY_WPS_OPEN
ZOS_SECURITY_WPS_SECURE
ZOS_SECURITY_UNKNOWN
ZOS_SECURITY_FORCE_32_BIT
zn_network_get_mac
zn_network_lookup
zn_network_ping
zn_network_scan
zn_network_scan_destroy_results
zn_network_verify
Protocols
TCP/TLS Client/Server
Types
zos_tcp_config_t
certs
gpio
host
interface
local_port
remote_port
use_tls
zn_tcp_connect
zn_tcp_connect_with_config
zn_tcp_disconnect
zn_tcp_get_client_info
zn_tcp_listen
zn_tcp_poll
zn_tcp_read
zn_tcp_read_with_buffer
zn_tcp_register_client_event_handlers
zn_tcp_register_server_event_handlers
zn_tcp_stop_listening
zn_tcp_write
zn_tls_connect
zn_tls_listen
zn_tls_stop_listening
UDP Client/Server
Types
zos_udp_client_config_t
gpio
host
interface
local_port
remote_port
zn_udp_close
zn_udp_connect
zn_udp_connect_with_config
zn_udp_listen
zn_udp_poll
zn_udp_query
zn_udp_read
zn_udp_read_with_buffer
zn_udp_receivefrom
zn_udp_register_receive_event_handler
zn_udp_sendto
zn_udp_stop_listening
zn_udp_write
HTTP Client
Types
zos_http_request_t
certs
content_length
content_type
interface
method
url
zos_http_response_header_t
key
next
value
zos_http_response_t
buffer
code
content_length
header_list
headers
version
zos_http_response_config_t
buffer
flags
max_size
timeout
zos_http_download_t
certs
checksum
delete_duplicate
flags
interface
local_filename
type
url
version
zos_http_upload_t
certs
content_type
form_name
interface
local_filename
remote_filename
url
zos_http_basic_header_t
HTTP_CONTENT_TYPE
HTTP_CONTENT_LENGTH
HTTP_TRANSFER_ENCODING
HTTP_LOCATION
HTTP_MAX_BASIC_HEADERS
zos_http_method_t
HTTP_GET
HTTP_POST
HTTP_HEAD
HTTP_PUT
HTTP_DELETE
zos_http_response_flags_t
HTTP_RESPONSE_ALL_HEADERS
zn_http_add_header
zn_http_close
zn_http_download
zn_http_get
zn_http_open_request
zn_http_poll
zn_http_post
zn_http_read
zn_http_read_status
zn_http_read_with_buffer
zn_http_receive_response
zn_http_receive_response_with_config
zn_http_response_cleanup
zn_http_upload
zn_http_write
HTTP Server
Types
http_server_param_t
key
next
value
http_server_header_t
key
next
value
http_server_dynamic_page_t
next
path
processor
http_server_tls_client_t
common_name
next
timestamp
http_custom_header_callback_t
http_server_authorize_callback_t
http_server_not_found_callback_t
http_server_request_processor_t
http_server_request_t
http_server_header_flag_t
HTTP_SERVER_HEADER_NONE
HTTP_SERVER_HEADER_GZIP
HTTP_SERVER_HEADER_CACHE
http_server_method_t
HTTP_METHOD_GET
HTTP_METHOD_POST
HTTP_METHOD_HEAD
HTTP_METHOD_DELETE
HTTP_METHOD_OPTIONS
HTTP_METHOD_PUT
http_server_request_header_t
HTTP_REQUEST_USER_AGENT
HTTP_REQUEST_TRANSFER_ENCODING
HTTP_REQUEST_CONTENT_TYPE
HTTP_REQUEST_AUTHORIZATION
HTTP_REQUEST_WS_KEY
HTTP_REQUEST_CONTENT_LENGTH
Macros
HTTP_SERVER_DYNAMIC_PAGE
HTTP_SERVER_DYNAMIC_PAGES_END
HTTP_SERVER_DYNAMIC_PAGES_START
HTTP_SERVER_REGISTER_DYNAMIC_PAGES
zn_hs_authorize_user
zn_hs_destroy_tls_client_list
zn_hs_get_header
zn_hs_get_method
zn_hs_get_param
zn_hs_get_tls_client_list
zn_hs_is_running
zn_hs_read_post_data
zn_hs_register_authorize_callback
zn_hs_register_dynamic_page
zn_hs_register_header_callback
zn_hs_register_not_found_callback
zn_hs_return_status_code
zn_hs_url_decode
zn_hs_write_chunked_data
zn_hs_write_data
zn_hs_write_not_found_response
zn_hs_write_reply_header
zn_hs_write_unauthorized_response
HTTP Server Stream
Types
zos_hs_handle_t
zos_hs_stream_callback_t
zos_hs_ws_connect_callback_t
zos_hs_ws_disconnect_callback_t
zos_hs_stream_method_t
HS_STREAM_UNKNOWN
HS_STREAM_WRITE
HS_STREAM_READ
HS_STREAM_LISTEN
HS_STREAM_UNLISTEN
Macros
ZOS_HS_INVALID_HANDLE
zn_hs_register_websocket_callbacks
zn_hs_stream_read
zn_hs_stream_register_callback
zn_hs_stream_unregister_callbacks
zn_hs_stream_write
zn_hs_stream_write_listener
WebSocket Client/Server
Types
zos_websocket_header_t
key
next
value
zos_websocket_config_t
buffer_size
certs
frame_type
gpio
headers
host
interface
zos_websocket_frame_t
final_frame
payload
payload_length
payload_type
zos_websocket_frame_type_t
WEBSOCKET_CONTINUATION_FRAME
WEBSOCKET_TEXT_FRAME
WEBSOCKET_BINARY_FRAME
zn_websocket_client_read_frame
zn_websocket_connect
zn_websocket_connect_with_config
zn_websocket_disconnect
zn_websocket_get_info
zn_websocket_poll
zn_websocket_read
zn_websocket_read_with_buffer
zn_websocket_register_client_event_handlers
zn_websocket_register_server_event_handlers
zn_websocket_write
SMTP
Types
zos_smtp_config_t
content
content_length
content_reader
subject
to_address
user
zos_smtp_content_reader_t
zn_smtp_send
zn_smtp_send_with_config
NTP
Types
ntp_packet_t
ntp_update_event_t
zn_ntp_update
Network Discovery
mDNS
Types
mdns_service_info_t
port
service_name
ttl
txt
txt_callback
mdns_txt_record_callback_t
zn_mdns_register_service
Periodic Broadcast
Types
broadcast_callback_t
zn_broadcast_set_callback
Peripherals
GPIO
Types
zos_gpio_irq_callback_t
zos_gpio_direction_t
GPIO_INPUT_PULLUP
GPIO_INPUT_PULLDOWN
GPIO_INPUT_HIGHZ
GPIO_OUTPUT_PUSHPULL
GPIO_OUTPUT_OPENDRAIN
GPIO_OUTPUT_OPENDRAIN_PULLUP
GPIO_OUTPUT_NONE
zos_gpio_irq_trigger_t
GPIO_IRQ_TRIGGER_RISING_EDGE
GPIO_IRQ_TRIGGER_FALLING_EDGE
GPIO_IRQ_TRIGGER_BOTH_EDGES
zn_gpio_deinit
zn_gpio_direct_init
zn_gpio_direct_set
zn_gpio_get
zn_gpio_init
zn_gpio_irq_disable
zn_gpio_irq_enable
zn_gpio_mask_clear
zn_gpio_mask_get
zn_gpio_mask_set
zn_gpio_set
ADC
Types
zos_adc_config_t
gain
resolution
sampling_cycle
zos_adc_lut_t
zos_adc_sample_t
ADC_SAMPLE_RAW
ADC_SAMPLE_VOLTAGE
zn_adc_add_lut
zn_adc_direct_init
zn_adc_direct_sample
zn_adc_gpio_to_peripheral
zn_adc_init
zn_adc_remove_lut
zn_adc_safe_sample
zn_adc_sample
zn_adc_sample_and_convert
zn_adc_sample_stream
PWM
zn_pwm_stop
zn_pwm_update
I2C Master
Types
zos_i2c_message_t
buffer
flags
length
zos_i2c_device_t
address
flags
port
read_timeout
retries
speed
zos_i2c_write_flag_t
I2C_WRITE_FLAG_CONTINUED_WRITE
Macros
I2C_CLOCK_HIGH_SPEED
I2C_CLOCK_LOW_SPEED
I2C_CLOCK_STANDARD_SPEED
I2C_FLAG_HEXIFY
I2C_MSG_NO_START_SEQ
I2C_MSG_NO_STOP_SEQ
I2C_MSG_READ
I2C_MSG_READ_AFTER_WRITE
I2C_MSG_WRITE
zn_i2c_init
zn_i2c_master_read_reg
zn_i2c_master_read_reg8
zn_i2c_master_write_reg
zn_i2c_master_write_reg8
zn_i2c_stream_close
zn_i2c_stream_configure
zn_i2c_stream_open
zn_i2c_stream_read
zn_i2c_stream_read_reg
zn_i2c_stream_read_reg8
zn_i2c_stream_set_slave_address
zn_i2c_stream_write
zn_i2c_stream_write_reg
zn_i2c_stream_write_reg8
zn_i2c_stream_write_with_flags
zn_i2c_transfer
SPI Master
Types
zos_spi_message_t
length
rx_buffer
tx_buffer
zos_spi_device_t
chip_select
flags
speed
Macros
SPI_FLAG_CLOCK_FALLING_EDGE
SPI_FLAG_CLOCK_IDLE_HIGH
SPI_FLAG_CLOCK_IDLE_LOW
SPI_FLAG_CLOCK_RISING_EDGE
SPI_FLAG_DONT_KEEK_ASSERTED
SPI_FLAG_HEXIFY
SPI_FLAG_KEEP_ASSERTED
SPI_FLAG_LSB_FIRST
SPI_FLAG_MSB_FIRST
SPI_FLAG_NO_HEXIFY
SPI_FLAG_NO_READ_AFTER_WRITE
SPI_FLAG_READ_AFTER_WRITE
zn_spi_master_deassert
zn_spi_master_lock_bus
zn_spi_master_unlock_bus
zn_spi_stream_close
zn_spi_stream_configure
zn_spi_stream_open
zn_spi_stream_read
zn_spi_stream_read_with_buffer
zn_spi_stream_set_slave_select
zn_spi_stream_write
zn_spi_transfer
UART
Types
zos_uart_config_t
baud_rate
data_width
flow_control
parity
stop_bits
zos_uart_mode_config_t
buffer
error_status_callback
get_next_packet
length
mode
ring_buffer_full
zos_uart_buffer_t
buffer
length
zos_uart_callback_t
zos_uart_data_width_t
zos_uart_flow_control_t
zos_uart_mode_t
zos_uart_parity_t
zos_uart_stop_bits_t
UART_WIDTH_5BIT
UART_WIDTH_6BIT
UART_WIDTH_7BIT
UART_WIDTH_8BIT
UART_WIDTH_9BIT
UART_STOP_BITS_1
UART_STOP_BITS_2
UART_FLOW_DISABLED
UART_FLOW_CTS_RTS
UART_NO_PARITY
UART_ODD_PARITY
UART_EVEN_PARITY
UART_MODE_IRQ
UART_MODE_RING_BUFFER
UART_MODE_ZERO_COPY
zn_uart_configure
zn_uart_get_bytes_received
zn_uart_is_processing_packet
zn_uart_peek_bytes
zn_uart_receive_bytes
zn_uart_register_rx_callback
zn_uart_set_packet
zn_uart_set_packet_mode
zn_uart_set_packet_timed_out
zn_uart_set_tx_processor
zn_uart_transmit_bytes
Custom Commands
Types
zos_command_t
func
has_return_value
key
max_argc
min_argc
shortcut
zos_var_args_command_t
func
key
zos_cmd_list_t
zos_cmd_lists_t
zos_cmd_func_t
zos_cmd_list_flag_t
zos_cmd_list_type_t
zos_cmd_writer_t
CMD_LIST_FLAG_IS_LAST_IN_LIST
CMD_LIST_FLAG_EXCLUDE_FROM_SAVE
CMD_LIST_TYPE_COMMANDS
CMD_LIST_TYPE_GETTERS
CMD_LIST_TYPE_SETTERS
zos_cmd_result_t
CMD_SUCCESS
CMD_FAILED
CMD_PARSE_ERROR
CMD_UNKNOWN
CMD_TOO_FEW_ARGS
CMD_TOO_MANY_ARGS
CMD_UNKNOWN_OPTION
CMD_BAD_ARGS
CMD_BUFFER_OVERFLOW
CMD_SET_OK
CMD_EXECUTE_AOK
CMD_STOPPED
CMD_IN_PROGRESS
Macros
ZOS_ADD_COMMAND
ZOS_ADD_GETTER
ZOS_ADD_SETTER
ZOS_CMD_ADD_CMD_LIST
ZOS_CMD_CREATE_CMD_LISTS
ZOS_CMD_PARSE_HEX_ARG
ZOS_CMD_PARSE_HEX_ARG_WITH_VAR
ZOS_CMD_PARSE_INT_ARG
ZOS_CMD_PARSE_INT_ARG_WITH_VAR
ZOS_CMD_REGISTER_COMMANDS
ZOS_CMD_UNREGISTER_COMMANDS
ZOS_COMMAND_LISTS
ZOS_COMMANDS_END
ZOS_COMMANDS_START
ZOS_DEFINE_COMMAND
ZOS_DEFINE_GETTER
ZOS_DEFINE_SETTER
ZOS_GETTERS_END
ZOS_GETTERS_START
ZOS_SETTERS_END
ZOS_SETTERS_START
zn_cmd_format_response
zn_cmd_read_write_data
zn_cmd_register_commands
zn_cmd_set_bool
zn_cmd_set_console_enabled
zn_cmd_set_encoded_str
zn_cmd_set_flag
zn_cmd_set_hex
zn_cmd_set_int
zn_cmd_set_str
zn_cmd_start_response
zn_cmd_unregister_commands
zn_cmd_write_response
zn_cmd_write_response_data
Event Handling
Types
zos_event_handler_t
zos_event_flag_t
ZOS_EVENT_FLAG_RUN_NOW
ZOS_EVENT_FLAG_ALLOW_DUPLCIATE
ZOS_EVENT_FLAG_FROM_IRQ
ZOS_EVENT_FLAG_REQUIRE_WLAN
ZOS_EVENT_FLAG_REQUIRE_SOFTAP
ZOS_EVENT_FLAG_SYS_EVENT_THREAD
ZOS_EVENT_FLAG_NETWORK_THREAD
Macros
EVENT_FLAGS1
EVENT_FLAGS2
EVENT_FLAGS3
EVENT_FLAGS4
zn_event_disable_irq_events
zn_event_enable_irq_events
zn_event_irq_events_enabled
zn_event_is_registered
zn_event_issue
zn_event_register_periodic
zn_event_register_timed
zn_event_restart
zn_event_trigger
zn_event_unregister
zn_event_unregister_all
zn_event_update_periodic
RTOS
Mutex
zn_rtos_mutex_deinit
zn_rtos_mutex_init
zn_rtos_mutex_lock
zn_rtos_mutex_trylock
zn_rtos_mutex_unlock
Semaphore
zn_rtos_semaphore_deinit
zn_rtos_semaphore_get
zn_rtos_semaphore_init
zn_rtos_semaphore_reset
zn_rtos_semaphore_set
Queue
zn_rtos_queue_deinit
zn_rtos_queue_get_count
zn_rtos_queue_init
zn_rtos_queue_is_empty
zn_rtos_queue_is_full
zn_rtos_queue_pop
zn_rtos_queue_push
Timer
zn_rtos_timer_deinit
zn_rtos_timer_init
zn_rtos_timer_is_running
zn_rtos_timer_reload
zn_rtos_timer_start
zn_rtos_timer_stop
zn_rtos_timer_update
Events
zn_rtos_event_flags_deinit
zn_rtos_event_flags_init
zn_rtos_event_flags_set
zn_rtos_event_flags_wait_for_all
zn_rtos_event_flags_wait_for_any
Miscellaneous
zn_rtos_delay_milliseconds
zn_rtos_get_time
Time
Types
zos_time_t
milliseconds
seconds
zn_time_get_rtc_time
zn_time_get_rtc_time_raw
zn_time_get_up_time
zn_time_get_up_time_raw
zn_time_get_utc_time
zn_time_to_str
zn_time_utc_to_str
File System
Types
zos_file_t
checksum
flags
memory_handle
name
next
size
type
version
zos_file_parameters_t
flags
limit
max_version
memory
min_version
name
offset
type
zos_file_descriptor_t
current_sector
current_sector_position
data_start_addr
file_size
first_sector
position
zos_file_system_stats_t
bytes_available
bytes_used
file_count
total_size
zos_log_stats_t
bytes_remaining
bytes_used
invalid_records
record_count
zos_file_list_callback_t
zos_log_header_t
zos_file_flag_t
FILE_FLAG_VALID
FILE_FLAG_EXECUTABLE
FILE_FLAG_ENCRYPTED
FILE_FLAG_INTERNAL
FILE_FLAG_BOOTABLE
FILE_FLAG_USER
FILE_FLAG_ESSENTIAL
FILE_FLAG_BACKUP
FILE_FLAG_UNPROTECTED
FILE_FLAG_LOG
FILE_FLAG_INVALID
zos_file_memory_t
FILE_MEMORY_INTERNAL
FILE_MEMORY_EXTENDED
FILE_MEMORY_BULK
FILE_MEMORY_INTERNAL_OR_EXTENDED
FILE_MEMORY_EXTENDED_OR_BULK
FILE_MEMORY_ALL
zos_file_type_t
FILE_TYPE_KERNEL
FILE_TYPE_WIFI_FW
FILE_TYPE_SHARED_LIB
FILE_TYPE_TLS_CERT
FILE_TYPE_TXT_LOG
FILE_TYPE_NVM
FILE_TYPE_MISC_APP
FILE_TYPE_REGULAR_APP
FILE_TYPE_SUB_APP
FILE_TYPE_ZAP
FILE_TYPE_SAFEMODE_APP
FILE_TYPE_USER_RANGE_START
FILE_TYPE_USER_RANGE_END
FILE_TYPE_TEMPORARY
FILE_TYPE_GPIO_CONFIG
FILE_TYPE_COMMAND_HELP
FILE_TYPE_SETUP_SCRIPT
FILE_TYPE_MISC_FIX_LEN
FILE_TYPE_INVALID
Macros
FILE_ANY_TYPE
FILE_MAKE_VERSION
FILE_VERSION_ARGS
ZOS_FILE_HANDLE_MEMORY
ZOS_FILE_HANDLE_SECTOR
ZOS_FILE_SECTOR_SIZE
ZOS_LOG_GET_LENGTH
ZOS_LOG_GET_NEXT
ZOS_LOG_IS_VALID
ZOS_LOG_RECORD_VALID_FLAG
ZOS_MAX_FILENAME_LEN
zn_file_close
zn_file_create
zn_file_delete
zn_file_destroy_list
zn_file_get_descriptor
zn_file_get_version_int
zn_file_get_version_str
zn_file_list
zn_file_list_with_callback
zn_file_list_with_parameters
zn_file_open
zn_file_poll
zn_file_read
zn_file_system_get_stats
zn_file_write
zn_log_file_append
zn_log_file_get_stats
zn_log_file_open
zn_log_file_read
System
Powersave
zn_powersave_sleep
Updates
Backup Registers
zn_backup_register_read
zn_backup_register_write
Monitor
zos_system_monitor_t
last_update
longest_permitted_delay
zn_register_system_monitor
zn_unregister_system_monitor
zn_update_system_monitor
Miscellaneous
ZOS_RTOS_DEFINE_ISR
zn_system_reboot
zn_system_register_irq_callback
zn_system_register_system_tick_callback
Libraries
Cloud
Silicon-to-Cloud
Types
Macros
MQTT
mqtt_connect
mqtt_deinit
mqtt_disconnect
mqtt_init
mqtt_open
mqtt_publish
mqtt_subscribe
mqtt_unsubscribe
SMQ
Error codes returned by function SMQ_getMessage
SMQE_BUF_OVERFLOW
SMQE_DISCONNECT
SMQE_INVALID_URL
SMQE_PONGTIMEOUT
SMQE_PROTOCOL_ERROR
SMQE_TIMEOUT
Response codes returned by function SMQ_getMessage
SMQ_CREATEACK
SMQ_CREATESUBACK
SMQ_SUBACK
SMQ_SUBCHANGE
SMQ
buf
bytesRead
clientTid
frameLen
ptid
status
subtid
tid
timeout
SMQ_getMsgSize
SMQ_setCtx
SMQ_connect
SMQ_constructor
SMQ_create
SMQ_createsub
SMQ_destructor
SMQ_disconnect
SMQ_getMessage
SMQ_init
SMQ_observe
SMQ_pubflush
SMQ_publish
SMQ_subscribe
SMQ_unobserve
SMQ_unsubscribe
SMQ_write
SMQ_wrtstr
Display
8x8 LED Matrix Library
led_matrix8x8_frame_t
data
display_time
led_matrix8x8_animate_context_t
current_frame
frame_queue
populate_event_handler
led_matrix8x8_context_t
blink_rate
brightness
column
device
display_buffer
end
operation
position
rate
scroll
text
text_buffer
led_matrix8x8_operation_t
LED_MATRIX_NO_OPERATION
LED_MATRIX_ROTATE90_CLOCKWISE
LED_MATRIX_ROTATE90_ANTICLOCKWISE
led_matrix8x8_animate
led_matrix8x8_clear_display
led_matrix8x8_deinit
led_matrix8x8_flush_frames
led_matrix8x8_get_context
led_matrix8x8_get_current_frame
led_matrix8x8_get_text
led_matrix8x8_init
led_matrix8x8_push_frame
led_matrix8x8_set_blink_rate
led_matrix8x8_set_brightness
led_matrix8x8_set_operation
led_matrix8x8_set_scroll_rate
led_matrix8x8_set_text
led_matrix8x8_update_display
LCD Monochrome Library
lcd_draw_line
lcd_draw_rect
lcd_fill_rect
lcd_init
lcd_put_char_xy
lcd_put_pixel
lcd_put_str_centered
lcd_put_str_xy
lcd_refresh
lcd_set_background_color
lcd_set_char_spacing
lcd_set_font
lcd_set_font_width
lcd_set_foreground_color
lcd_set_pixel
Sensor
Accelerometer Data Types
accelerometer_config_t
axis_en
fullscale
mode
samp_freq
wake_accel_threshold
accelerometer_data_t
x
y
z
accel_wom_thr
accel_fullscale_t
ACCEL_FULLSCALE_2G
ACCEL_FULLSCALE_4G
ACCEL_FULLSCALE_8G
ACCEL_FULLSCALE_16G
accel_mode_t
ACCEL_MODE_NORMAL
ACCEL_MODE_LOW_POWER
ACCEL_MODE_POWER_DOWN
accel_sample_freq_t
ACCEL_SAMP_FREQ_1HZ
ACCEL_SAMP_FREQ_10HZ
ACCEL_SAMP_FREQ_25HZ
ACCEL_SAMP_FREQ_50HZ
ACCEL_SAMP_FREQ_100HZ
ACCEL_SAMP_FREQ_200HZ
ACCEL_SAMP_FREQ_400HZ
Gyroscope Data Types
gyroscope_config_t
axis_en
fullscale
Hygrometer Data Types
hygrometer_data_t
fraction
raw
whole
Magnetometery Data Types
magnetometer_data_t
x
y
z
Thermometer Data Types
thermometer_data_t
fraction
raw
value
whole
SENSOR_LIB_REGISTER_SENSOR_TYPE
sensor_id_t
SENSOR_ACCELEROMETER
SENSOR_HYGROMETER
SENSOR_THERMOMETER
SENSOR_GYROSCOPE
SENSOR_MAGNETOMETER
sensor_get_data
sensor_has_new_data
sensor_init
Peripherals
IO Expander
io_expander_dir_get
io_expander_dir_get_all
io_expander_dir_set
io_expander_dir_set_all
io_expander_pol_get
io_expander_pol_get_all
io_expander_pol_set
io_expander_pol_set_all
io_expander_val_get
io_expander_val_get_all
io_expander_val_set
io_expander_val_set_all
Protocols
FTP
Types
ftp_upload_config_t
directory
filename
password
port
state_callback_callback
timeout
username
ftp_context_t
ftp_state_change_func_t
ftp_state_t
FTP_STATE_IDLE
FTP_STATE_INIT
FTP_STATE_OPEN
FTP_STATE_LOGIN
FTP_STATE_USER
FTP_STATE_PASS
FTP_STATE_CWD
FTP_STATE_TYPE
FTP_STATE_LISTEN
FTP_STATE_ASK
FTP_STATE_STOR
FTP_STATE_DATA
FTP_STATE_QUIT
FTP_STATE_CLOSE
FTP_STATE_END
FTP_STATE_FAIL
FTP_STATE_COUNT
ftp_async_upload
ftp_async_upload_cleanup
ftp_async_upload_write
ftp_get_state_str
Utilities
String
hex_parse_str_buf
int_to_str
ip_to_str
mac_to_str
ssid_to_str
str_buffer_pool_add
str_buffer_pool_add_with_len
str_buffer_pool_remove
str_chop
str_empty
str_hex
str_hex_to_int
str_lstrip
str_parse_bool
str_parse_hex
str_parse_hex_buf
str_parse_int
str_reverse
str_rstrip
str_strip
str_to_ip
str_to_mac
str_to_uint32
str_to_uint64
str_tolower
strnstr
uint64_to_str
JSON
Types
json_tok_t
boolean
data
int64
ptr
reserved
str
type
uint32
uint64
json_parse_config_t
buffer_len
reader
token_callback
json_parse_context_t
json_parse_reader_t
json_token_callback_t
json_type_t
JSON_TYPE_ARRAY
JSON_TYPE_OBJECT
JSON_TYPE_STRING
JSON_TYPE_BOOLEAN
JSON_TYPE_INTEGER
JSON_TYPE_INTEGER64
JSON_TYPE_FLOAT
JSON_TYPE_NULL
Macros
JSON_BOOL
JSON_GET_VALUE
JSON_GET_VALUE_WITH
JSON_INT32
JSON_INT64
JSON_STR
JSON_UINT32
JSON_UINT64
json_context_get_current_parent
json_context_get_token
json_context_get_value
json_context_get_value_with_limit
json_context_skip_tokens
json_decode_buffer
json_encode_buffer
json_parse_chunked
json_parse_context_deinit
json_parse_context_init
CSV
Types
csv_context_t
csv_deinit
csv_get_delimited_data
csv_init
csv_read_line
Base64
Types
base64_decode_context_t
base64_encode_context_t
base64_reader_t
base64_writer_t
base64_decode
base64_decode_with_reader
base64_destroy_context
base64_encode
base64_encode_with_writer
base64_init_decode_context
base64_init_encode_context
Sorting
bubble_sort_linked_list
bubble_sort_ptr
Table/Lookup
Macros
TABLE_LOOKUP
TABLE_LOOKUP_LINEAR
TABLE_REVERSE_LOOKUP
table_linear_lookup
table_lookup
table_reverse_lookup
CRC
Types
zos_crc_type_t
CRC_TYPE_CCITT
crc_configure
crc_deinit
crc_get_result
crc_init
crc_reset
crc_start
Button
Types
button_config_t
change
click
click_time
debounce
event_handler
execution_context
press_time
toggle
button_active_level_t
BUTTON_ACTIVE_HIGH
BUTTON_ACTIVE_LOW
button_execution_context_t
BUTTON_CONTEXT_DEFAULT
BUTTON_CONTEXT_EVENT_THREAD
BUTTON_CONTEXT_IRQ
button_deinit
button_init
button_is_active
button_update_config
Cryptography
AES
Types
aes_context_t
aes_decrypt_cbc
aes_decrypt_ecb
aes_encrypt_cbc
aes_encrypt_ecb
aes_setkey_dec
aes_setkey_enc
MD5
Types
md5_context_t
buffer
ipad
opad
state
total
md5
md5_finish
md5_hmac
md5_hmac_finish
md5_hmac_starts
md5_hmac_update
md5_starts
md5_update
SHA1
Types
sha1_context_t
buffer
ipad
opad
state
total
sha1
sha1_finish
sha1_hmac
sha1_hmac_finish
sha1_hmac_starts
sha1_hmac_update
sha1_starts
sha1_update
SHA2
Types
sha2_context_t
buffer
ipad
is224
opad
state
total
sha2
sha2_finish
sha2_hmac
sha2_hmac_finish
sha2_hmac_starts
sha2_hmac_update
sha2_starts
sha2_update
SHA4
Types
sha4_context_t
buffer
ipad
is384
opad
state
total
sha4
sha4_finish
sha4_starts
sha4_update
zn_get_random_buffer
zn_get_random_uint32
Fixed-Point Integer
Types
fpi_str_buffer_t
fpi_uword_t
fpi_word_t
Macros
fpi_abs
fpi_add
fpi_div
FPI_E
fpi_fracpart
fpi_fromint
fpi_int_to_str
fpi_int_to_str2
fpi_mul
FPI_ONE
FPI_ONE_HALF
FPI_PI
fpi_rconst
fpi_sub
fpi_to_str
fpi_toint
FPI_TWO
fpi_divide
fpi_from_str
fpi_multiply
fpi_to_str_with_padding
Deprecated APIs
zn_hs_write_error_response
zn_pwm_direct_start
zn_pwm_direct_stop
zn_pwm_gpio_to_peripheral
zn_pwm_update_duty_cycle
zx_adc_init
zx_adc_sample
zx_close
zx_file_close
zx_file_create
zx_file_delete
zx_file_list
zx_file_open
zx_file_read
zx_file_write
zx_gpio_deinit
zx_gpio_get
zx_gpio_init
zx_gpio_set
zx_http_add_header
zx_http_close
zx_http_download
zx_http_get
zx_http_post
zx_http_read
zx_http_read_status
zx_http_upload
zx_http_write
zx_i2c_master_close
zx_i2c_master_configure
zx_i2c_master_open
zx_i2c_master_read
zx_i2c_master_read_reg
zx_i2c_master_read_reg8
zx_i2c_master_write
zx_i2c_master_write_reg
zx_i2c_master_write_reg8
zx_i2c_master_write_with_flags
zx_issue_command
zx_issue_command_return_data
zx_issue_command_return_list_ptr
zx_issue_command_return_str
zx_issue_command_return_uint32
zx_issue_command_with_data
zx_network_down
zx_network_lookup
zx_network_ping
zx_network_restart
zx_network_scan
zx_network_up
zx_network_verify
zx_nvm_save
zx_powersave_sleep
zx_pwm_stop
zx_pwm_update
zx_read
zx_settings_get_print_str
zx_settings_get_str
zx_settings_get_uint32
zx_settings_load
zx_settings_save
zx_settings_set_int32
zx_settings_set_str
zx_settings_set_uint32
zx_setup_start
zx_setup_stop
zx_smtp_send
zx_spi_master_close
zx_spi_master_configure
zx_spi_master_open
zx_spi_master_read
zx_spi_master_write
zx_system_reboot
zx_tcp_connect
zx_tcp_disconnect
zx_tcp_listen
zx_tcp_read
zx_tcp_stop_listening
zx_tcp_write
zx_tls_connect
zx_tls_listen
zx_tls_stop_listening
zx_udp_close
zx_udp_connect
zx_udp_listen
zx_udp_query
zx_udp_read
zx_udp_sendto_host
zx_udp_sendto_ip
zx_udp_stop_listening
zx_udp_write
zx_websocket_connect
zx_websocket_connect_with_config
zx_websocket_disconnect
zx_websocket_get_info
zx_websocket_read
zx_websocket_write
zx_write
Experimental APIs
zn_netif_notify_event
zn_netif_packet_adjust_payload_ptr
zn_netif_packet_alloc_rx
zn_netif_packet_get_payload
zn_netif_packet_get_size
zn_netif_packet_release_rx
zn_netif_packet_release_tx
zn_netif_packet_set_size
zn_netif_register
zn_netif_unregister
Selib
INFINITE_TMO
SOCKET
mainTask
se_accept
se_bind
se_close
se_connect
se_recv
se_send
se_sockValid
Lib_sensor_airquality
airquality_data_t
co2_equ
tvoc
Lib_sensor_light
light_data_t
lux
Command API Extensions
Commands
zap_run
Variables
zap.auto_run
zap.debug.enabled
zap.debug.ignore_settings
zap.info
Application Examples
basic
adc
aes_ctr
blinky
buffer_dump
button
display_animation
display_stream
file_list
ftp_upload
gpio
hello_led_matrix
hello_world
http_methods
http_server
http_stream
i2c
json_parser
log_file
network_verify
nfc_url
scan
softap_tcp_server
system_monitor
tcp_client
uart
udp_client
udp_hello_gpio
web_setup
websocket_client
websocket_server
cloud
bluemix
mqttdemo
demo
accelerometer_stream
led_matrix
moray3d
pong
uart_blaster
nxp
lcd_hello_world
lcd_scan
nfc3d
nxp3d
sensors
accel_interrupt
accelerometer
custom_driver
custom_sensors
gyroscope
hygrometer
io_expander
magnetometer
thermometer
SDK User Guide
Overview
Getting Started
Device Support
Signing up for a Zentri DMS Account
Installing the SDK
Completing Installation
Setting Up the ZentriOS Device
Building, Downloading, Running
Re-running the ZentriOS App
Custom SDK Installation
Setting Up the ZentriOS Development Environment
Installing the ZentriOS SDK
Setting Up the IDE
Installing the ZentriOS Plugin
Reinstalling the ZentriOS Plugin
Using the SDK
ZentriOS Menus
Creating a New Project
Editing SDK Settings
Building Applications
Running Applications
Stopping an Application
Cleaning the Project
Building for a New Device
Modifying Project Settings
App Store
Debugging
Releasing Apps to the DMS
Troubleshooting
Additional Information
Command API
Glossary
Versions
Hardware Support
General Information
List of Articles
TCP is a Stream
Miscellaneous
Core
Other core functions.
More...
Other core functions.