5.11.0.0R3
Software Development Kit
 
Loading...
Searching...
No Matches
wiced_management.h File Reference

Data Structures

struct  configuration_entry_t
 
struct  wiced_ip_address_list_t
 
struct  wiced_ip_setting_t
 

Typedefs

typedef void(* wiced_network_link_callback_t) (void *user_data)
 

Enumerations

enum  configuration_data_type_t {
  CONFIG_STRING_DATA , CONFIG_UINT8_DATA , CONFIG_UINT16_DATA , CONFIG_UINT32_DATA ,
  CONFIG_IPADDR_DATA
}
 
enum  wiced_link_status_t { WICED_LINK_UP , WICED_LINK_DOWN }
 
enum  wiced_link_subscription_t { WICED_LINK_UP_SUBSCRIPTION , WICED_LINK_DOWN_SUBSCRIPTION }
 
enum  wiced_network_config_t { WICED_USE_EXTERNAL_DHCP_SERVER , WICED_USE_STATIC_IP , WICED_USE_INTERNAL_DHCP_SERVER , WICED_USE_EXTERNAL_DHCP_SERVER_RESTORE }
 
enum  wiced_network_packet_dir_t { WICED_NETWORK_PACKET_TX , WICED_NETWORK_PACKET_RX }
 

Functions

wiced_result_t wiced_configure_device (const configuration_entry_t *config)
 
wiced_result_t wiced_core_deinit (void)
 
wiced_result_t wiced_core_init (void)
 
void wiced_deep_sleep_disable_packet_buffering (void)
 
wiced_bool_t wiced_deep_sleep_is_networking_idle (wiced_interface_t interface)
 
wiced_bool_t wiced_deep_sleep_save_packet (wiced_buffer_t buffer, wwd_interface_t interface)
 
void wiced_deep_sleep_set_networking_ready (void)
 
wiced_result_t wiced_deinit (void)
 
wiced_result_t wiced_disable_powersave (void)
 
wiced_result_t wiced_enable_powersave (void)
 
wiced_result_t wiced_get_default_ready_interface (wiced_interface_t *interface)
 
wiced_interface_t wiced_get_interface (void)
 
wiced_result_t wiced_init (void)
 
wiced_result_t wiced_network_create_packet_pool (uint8_t *memory_pointer, uint32_t memory_size, wiced_network_packet_dir_t direction)
 
wiced_result_t wiced_network_deinit (void)
 
wiced_result_t wiced_network_deregister_link_callback (wiced_network_link_callback_t link_up_callback, wiced_network_link_callback_t link_down_callback, wiced_interface_t interface)
 
wiced_result_t wiced_network_down (wiced_interface_t interface)
 
wiced_result_t wiced_network_get_clients_ip_address_list (void *ip_address_list)
 
wiced_result_t wiced_network_get_hostname (wiced_hostname_t *name)
 
wiced_result_t wiced_network_init (void)
 
wiced_bool_t wiced_network_is_ip_up (wiced_interface_t interface)
 
wiced_bool_t wiced_network_is_up (wiced_interface_t interface)
 
wiced_result_t wiced_network_register_link_callback (wiced_network_link_callback_t link_up_callback, void *link_up_user_data, wiced_network_link_callback_t link_down_callback, void *link_down_user_data, wiced_interface_t interface)
 
wiced_result_t wiced_network_resume (void)
 
wiced_result_t wiced_network_resume_after_deep_sleep (wiced_interface_t interface, wiced_network_config_t config, const wiced_ip_setting_t *ip_settings)
 
wiced_result_t wiced_network_set_hostname (const char *name)
 
wiced_result_t wiced_network_suspend (void)
 
wiced_result_t wiced_network_up (wiced_interface_t interface, wiced_network_config_t config, const wiced_ip_setting_t *ip_settings)
 
wiced_result_t wiced_network_up_default (wiced_interface_t *interface, const wiced_ip_setting_t *ap_ip_settings)
 
wiced_result_t wiced_reconfigure_device (const configuration_entry_t *config)
 
wiced_result_t wiced_set_interface (wiced_interface_t interface)
 

Detailed Description

Defines functions to manage the WICED system

Typedef Documentation

◆ wiced_network_link_callback_t

typedef void(* wiced_network_link_callback_t) (void *user_data)

Network link callback

Enumeration Type Documentation

◆ configuration_data_type_t

DCT app section configuration item data type

Enumerator
CONFIG_STRING_DATA 

String data type

CONFIG_UINT8_DATA 

uint8 data type

CONFIG_UINT16_DATA 

uint16 data type

CONFIG_UINT32_DATA 

uint32 data type

CONFIG_IPADDR_DATA 

wiced_ip_address_t data type

◆ wiced_link_status_t

WICED Network link status

Enumerator
WICED_LINK_UP 

Link status up

WICED_LINK_DOWN 

Link status down

◆ wiced_link_subscription_t

WICED Network link subscription types denote whether to subscribe for link up or link down events

Enumerator
WICED_LINK_UP_SUBSCRIPTION 

Link up event subscription

WICED_LINK_DOWN_SUBSCRIPTION 

Link down event subscription

◆ wiced_network_config_t

IP address configuration options

Enumerator
WICED_USE_EXTERNAL_DHCP_SERVER 

Client interface: use an external DHCP server

WICED_USE_STATIC_IP 

Client interface: use a fixed IP address

WICED_USE_INTERNAL_DHCP_SERVER 

softAP interface: use the internal DHCP server

WICED_USE_EXTERNAL_DHCP_SERVER_RESTORE 

Client interface: use an external DHCP server; restore last saved DHCP state

◆ wiced_network_packet_dir_t

Enumerator
WICED_NETWORK_PACKET_TX 

Network packet for data transmission

WICED_NETWORK_PACKET_RX 

Network packet for data reception