Netapp_api

Classes
struct	_netapp_dhcp_ret_args_t
struct	_netapp_ipconfig_ret_args_t
struct	_netapp_pingreport_args

Typedefs
typedef struct _netapp_dhcp_ret_args_t	tNetappDhcpParams
typedef struct _netapp_ipconfig_ret_args_t	tNetappIpconfigRetArgs
typedef struct _netapp_pingreport_args	netapp_pingreport_args_t

Functions
INT32	netapp_config_mac_adrress (UINT8 *mac)
	Configure device MAC address and store it in NVMEM. The value of the MAC address configured through the API will be stored in CC3000 non volatile memory, thus preserved over resets. More...
INT32	netapp_dhcp (UINT32 *aucIP, UINT32 *aucSubnetMask, UINT32 *aucDefaultGateway, UINT32 *aucDNSServer)
	netapp_dhcp is used to configure the network interface, static or dynamic (DHCP). In order to activate DHCP mode, aucIP, aucSubnetMask, aucDefaultGateway must be 0. The default mode of CC3000 is DHCP mode. Note that the configuration is saved in non volatile memory and thus preserved over resets. More...
INT32	netapp_timeout_values (UINT32 *aucDHCP, UINT32 *aucARP, UINT32 *aucKeepalive, UINT32 *aucInactivity)
	Set new timeout values. Function set new timeout values for: DHCP lease timeout, ARP refresh timeout, keepalive event timeout and socket inactivity timeout. More...
INT32	netapp_ping_send (UINT32 *ip, UINT32 ulPingAttempts, UINT32 ulPingSize, UINT32 ulPingTimeout)
	send ICMP ECHO_REQUEST to network hosts More...
INT32	netapp_ping_stop ()
	Stop any ping request. More...
void	netapp_ping_report ()
	Request for ping status. This API triggers the CC3000 to send asynchronous events: HCI_EVNT_WLAN_ASYNC_PING_REPORT. This event will carry the report structure: netapp_pingreport_args_t. This structure is filled in with ping results up till point of triggering API. netapp_pingreport_args_t: packets_sent - echo sent, packets_received - echo reply, min_round_time - minimum round time, max_round_time - max round time, avg_round_time - average round time. More...
void	netapp_ipconfig (tNetappIpconfigRetArgs *ipconfig)
	Obtain the CC3000 Network interface information. Note that the information is available only after the WLAN connection was established. Calling this function before associated, will cause non-defined values to be returned. More...
INT32	netapp_arp_flush ()
	Flushes ARP table. More...
INT32	netapp_set_debug_level (UINT32 ulLevel)
	Debug messages sent via the UART debug channel, this function enable/disable the debug level. More...

Detailed Description

Function Documentation

INT32 netapp_arp_flush

(

void

)

Flushes ARP table.

netapp_arp_flush

Parameters

none

Returns

none

INT32 netapp_config_mac_adrress

(

UINT8 *

mac

)

Configure device MAC address and store it in NVMEM. The value of the MAC address configured through the API will be stored in CC3000 non volatile memory, thus preserved over resets.

netapp_config_mac_adrress

Parameters

mac	device mac address, 6 bytes. Saved: yes

Returns

return on success 0, otherwise error.

INT32 netapp_dhcp	(	UINT32 *	aucIP,
		UINT32 *	aucSubnetMask,
		UINT32 *	aucDefaultGateway,
		UINT32 *	aucDNSServer
	)

netapp_dhcp is used to configure the network interface, static or dynamic (DHCP).
In order to activate DHCP mode, aucIP, aucSubnetMask, aucDefaultGateway must be 0. The default mode of CC3000 is DHCP mode. Note that the configuration is saved in non volatile memory and thus preserved over resets.

netapp_dhcp

Parameters

aucIP	device mac address, 6 bytes. Saved: yes
aucSubnetMask	device mac address, 6 bytes. Saved: yes
aucDefaultGateway	device mac address, 6 bytes. Saved: yes
aucDNSServer	device mac address, 6 bytes. Saved: yes

Returns

return on success 0, otherwise error.

Note

If the mode is altered a reset of CC3000 device is required in order to apply changes. note that asynchronous event of DHCP_EVENT, which is generated when an IP address is allocated either by the DHCP server or due to static allocation is generated only upon a connection to the AP was established.

void netapp_ipconfig

(

tNetappIpconfigRetArgs *

ipconfig

)

Obtain the CC3000 Network interface information. Note that the information is available only after the WLAN connection was established. Calling this function before associated, will cause non-defined values to be returned.

netapp_ipconfig

Parameters

[out]

ipconfig

This argument is a pointer to a tNetappIpconfigRetArgs structure. This structure is filled in with the network interface configuration. tNetappIpconfigRetArgs: aucIP - ip address, aucSubnetMask - mask, aucDefaultGateway - default gateway address, aucDHCPServer - dhcp server address aucDNSServer - dns server address, uaMacAddr - mac address, uaSSID - connected AP ssid

Returns

none

Note

The function is useful for figuring out the IP Configuration of the device when DHCP is used and for figuring out the SSID of the Wireless network the device is associated with.

void netapp_ping_report

(

)

Request for ping status. This API triggers the CC3000 to send asynchronous events: HCI_EVNT_WLAN_ASYNC_PING_REPORT. This event will carry the report structure: netapp_pingreport_args_t. This structure is filled in with ping results up till point of triggering API. netapp_pingreport_args_t:
packets_sent - echo sent, packets_received - echo reply, min_round_time - minimum round time, max_round_time - max round time, avg_round_time - average round time.

netapp_ping_report

Parameters

none

Returns

none

Note

When a ping operation is not active, the returned structure fields are 0.

INT32 netapp_ping_send	(	UINT32 *	ip,
		UINT32	ulPingAttempts,
		UINT32	ulPingSize,
		UINT32	ulPingTimeout
	)

send ICMP ECHO_REQUEST to network hosts

netapp_ping_send

Parameters

ip	destination IP address
pingAttempts	number of echo requests to send
pingSize	send buffer size which may be up to 1400 bytes
pingTimeout	Time to wait for a response,in milliseconds.

Returns

return on success 0, otherwise error.

Note

If an operation finished successfully asynchronous ping report event will be generated. The report structure is as defined by structure netapp_pingreport_args_t.

Warning

Calling this function while a previous Ping Requests are in progress will stop the previous ping request.

INT32 netapp_ping_stop

(

)

Stop any ping request.

netapp_ping_stop

Parameters

none

Returns

On success, zero is returned. On error, -1 is returned.

INT32 netapp_set_debug_level

(

UINT32

ulLevel

)

Debug messages sent via the UART debug channel, this function enable/disable the debug level.

netapp_set_debug_level

Parameters

[in]

level

debug level. Bitwise [0-8], 0(disable)or 1(enable). Bitwise map: 0 - Critical message, 1 information message, 2 - core messages, 3 - HCI messages, 4 - Network stack messages, 5 - wlan messages, 6 - wlan driver messages, 7 - epprom messages, 8 - general messages. Default: 0x13f. Saved: no

Returns

On success, zero is returned. On error, -1 is returned

INT32 netapp_timeout_values	(	UINT32 *	aucDHCP,
		UINT32 *	aucARP,
		UINT32 *	aucKeepalive,
		UINT32 *	aucInactivity
	)

Set new timeout values. Function set new timeout values for: DHCP lease timeout, ARP refresh timeout, keepalive event timeout and socket inactivity timeout.

netapp_timeout_values

Parameters

aucDHCP	DHCP lease time request, also impact the DHCP renew timeout. Range: [0-0xffffffff] seconds, 0 or 0xffffffff == infinity lease timeout. Resolution:10 seconds. Influence: only after reconnecting to the AP. Minimal bound value: MIN_TIMER_VAL_SECONDS - 10 seconds. The parameter is saved into the CC3000 NVMEM. The default value on CC3000 is 14400 seconds.
aucARP	ARP refresh timeout, if ARP entry is not updated by incoming packet, the ARP entry will be deleted by the end of the timeout. Range: [0-0xffffffff] seconds, 0 == infinity ARP timeout Resolution: 10 seconds. Influence: on runtime. Minimal bound value: MIN_TIMER_VAL_SECONDS - 10 seconds The parameter is saved into the CC3000 NVMEM. The default value on CC3000 is 3600 seconds.
aucKeepalive	Keepalive event sent by the end of keepalive timeout Range: [0-0xffffffff] seconds, 0 == infinity timeout Resolution: 10 seconds. Influence: on runtime. Minimal bound value: MIN_TIMER_VAL_SECONDS - 10 sec The parameter is saved into the CC3000 NVMEM. The default value on CC3000 is 10 seconds.
aucInactivity	Socket inactivity timeout, socket timeout is refreshed by incoming or outgoing packet, by the end of the socket timeout the socket will be closed Range: [0-0xffffffff] sec, 0 == infinity timeout. Resolution: 10 seconds. Influence: on runtime. Minimal bound value: MIN_TIMER_VAL_SECONDS - 10 sec The parameter is saved into the CC3000 NVMEM. The default value on CC3000 is 60 seconds.

Returns

return on success 0, otherwise error.

Note

If a parameter set to non zero value which is less than 10s, it will be set automatically to 10s.