Web Setup
Network

Functions for enabling/disabling web setup. More...

Modules

Types
Data types for web setup.
 

Functions

zos_result_t zn_setup_start (void)
 Start web setup. More...
 
zos_result_t zn_setup_stop (void)
 Stop web setup. More...
 
zos_result_t zn_setup_register_client_event_handler (zos_setup_client_event_t handler)
 Register setup client event handler. More...
 
zos_result_t zn_setup_register_finished_event_handler (zos_setup_finished_event_t handler)
 Register web setup finished event handler. More...
 
const char * zn_setup_get_client_os_str (const zos_softap_client_t *client)
 Return the Setup Client's Operating System string. More...
 

Detailed Description

Functions for enabling/disabling web setup.

Function Documentation

const char* zn_setup_get_client_os_str ( const zos_softap_client_t *  client)

Return the Setup Client's Operating System string.

When the setup client connects to the HTTP server it supplies its operating system type, setup_os_type_t . This API will convert setup_os_type_t to a printable string.

Parameters
clientSetup client return by zn_setup_register_client_event_handler()
Returns
String representation of client's OS
Examples:
basic/web_setup/web_setup.c.
zos_result_t zn_setup_register_client_event_handler ( zos_setup_client_event_t  handler)

Register setup client event handler.

Register an event handler to execute when a client connects/disconnects AND when a client connects to the HTTP server. See zos_setup_client_event_t for more info.

Note
The event handler executes in the Zap thread context
Parameters
handlerEvent handler to execute on client connect/disconnect
Returns
zos_result_t, result of API call
Examples:
basic/web_setup/web_setup.c.
zos_result_t zn_setup_register_finished_event_handler ( zos_setup_finished_event_t  handler)

Register web setup finished event handler.

Register an event handler to execute when web setup finishes. Web setup can finish by the following ways:

Note
The event handler executes in the Zap thread context
Returns
zos_result_t, result of API call
Examples:
basic/web_setup/web_setup.c.
zos_result_t zn_setup_start ( void  )

Start web setup.

See ZentriOS Command API documentation: setup web

See also ZentriOS Web App

Note
If no clients connect then setup will timeout after a configurable timeout. See the variable setup.web.idle_timeout
Returns
zos_result_t, result of API call
zos_result_t zn_setup_stop ( void  )

Stop web setup.

See ZentriOS Command API documentation: setup stop

Returns
zos_result_t, result of API call