Web Setup
Functions for enabling/disabling web setup. More...
Modules |
|
Types | |
Data types for web setup.
|
|
Functions |
|
gos_result_t | gos_setup_start (void) |
Start web setup.
More...
|
|
gos_result_t | gos_setup_stop (void) |
Stop web setup.
More...
|
|
gos_result_t | gos_setup_register_client_event_handler ( gos_setup_client_event_t handler) |
Register setup client event handler.
More...
|
|
gos_result_t | gos_setup_register_finished_event_handler ( gos_handler_t handler) |
Register web setup finished event handler.
More...
|
|
const char * | gos_setup_get_client_os_str (const gos_softap_client_t *client) |
Return the Setup Client's Operating System string.
More...
|
|
gos_result_t | gos_setup_ble_start (void) |
Start ble setup.
More...
|
|
Detailed Description
Functions for enabling/disabling web setup.
Function Documentation
◆ gos_setup_ble_start()
gos_result_t gos_setup_ble_start | ( | void |
|
) |
Start ble setup.
See Gecko OS Command API documentation: setup ble
- Note
- Advertised services can be configured by the variable setup.ble.flags
- Advertised device information can be configured by the variables setup.ble.device_id , setup.ble.company_id , and setup.ble.product_id
- Returns
- gos_result_t , result of API call
◆ gos_setup_get_client_os_str()
const char* gos_setup_get_client_os_str | ( | const gos_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, gos_setup_os_type_t . This API will convert gos_setup_os_type_t to a printable string.
- Parameters
-
client
Setup client return by gos_setup_register_client_event_handler()
- Returns
- String representation of client's OS
- Examples:
- wifi/web_setup/main.c .
◆ gos_setup_register_client_event_handler()
gos_result_t gos_setup_register_client_event_handler | ( | gos_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 gos_setup_client_event_t for more info.
- Note
- The event handler executes in the app thread context
- Parameters
-
handler
Event handler to execute on client connect/disconnect
- Returns
- gos_result_t , result of API call
- Examples:
- wifi/web_setup/main.c .
◆ gos_setup_register_finished_event_handler()
gos_result_t gos_setup_register_finished_event_handler | ( | gos_handler_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:
- Manually stopped, see gos_setup_stop()
- Idle timeout, see gos_setup_start()
- Client completes device setup
- Note
- The event handler executes in the app thread context
- Returns
- gos_result_t , result of API call
- Examples:
- wifi/device_setup/main.c , and wifi/web_setup/main.c .
◆ gos_setup_start()
gos_result_t gos_setup_start | ( | void |
|
) |
Start web setup.
See Gecko OS Command API documentation: setup web
See also Gecko OS Web App
- Note
- If no clients connect then setup will timeout after a configurable timeout. See the variable setup.web.idle_timeout
- Returns
- gos_result_t , result of API call
- Examples:
- wifi/device_setup/main.c , and wifi/web_setup/main.c .
◆ gos_setup_stop()
gos_result_t gos_setup_stop | ( | void |
|
) |
Stop web setup.
See Gecko OS Command API documentation: setup stop
- Returns
- gos_result_t , result of API call