API  2.2
TSmarT Software Library
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Functions

Functions

void wlan_init (tWlanCB sWlanCB, tFWPatches sFWPatches, tDriverPatches sDriverPatches, tBootLoaderPatches sBootLoaderPatches, tWlanReadInteruptPin sReadWlanInterruptPin, tWlanInterruptEnable sWlanInterruptEnable, tWlanInterruptDisable sWlanInterruptDisable, tWriteWlanPin sWriteWlanPin)
 Initialize wlan driver. More...
 
void wlan_start (unsigned short usPatchesAvailableAtHost)
 Start WLAN device. This function asserts the enable pin of the device (WLAN_EN), starting the HW initialization process. The function blocked until device Initialization is completed. Function also configure patches (FW, driver or bootloader) and calls appropriate device callbacks. More...
 
void wlan_stop (void)
 Stop WLAN device by putting it into reset state. More...
 
long wlan_connect (unsigned long ulSecType, char *ssid, long ssid_len, unsigned char *bssid, unsigned char *key, long key_len)
 Connect to AP. More...
 
long wlan_disconnect (void)
 Disconnect connection from AP. More...
 
long wlan_add_profile (unsigned long ulSecType, unsigned char *ucSsid, unsigned long ulSsidLen, unsigned char *ucBssid, unsigned long ulPriority, unsigned long ulPairwiseCipher_Or_Key, unsigned long ulGroupCipher_TxKeyLen, unsigned long ulKeyMgmt, unsigned char *ucPf_OrKey, unsigned long ulPassPhraseLen)
 When auto start is enabled, the device connects to station from the profiles table. Up to 7 profiles are supported. If several profiles configured the device choose the highest priority profile, within each priority group, device will choose profile based on security policy, signal strength, etc parameters. All the profiles are stored in CC3000 NVMEM. More...
 
long wlan_ioctl_del_profile (unsigned long ulIndex)
 Delete WLAN profile. More...
 
long wlan_set_event_mask (unsigned long ulMask)
 Mask event according to bit mask. In case that event is masked (1), the device will not send the masked event to host. More...
 
long wlan_ioctl_statusget (void)
 get wlan status: disconnected, scanning, connecting or connected More...
 
long wlan_ioctl_set_connection_policy (unsigned long should_connect_to_open_ap, unsigned long ulShouldUseFastConnect, unsigned long ulUseProfiles)
 When auto is enabled, the device tries to connect according the following policy: 1) If fast connect is enabled and last connection is valid, the device will try to connect to it without the scanning procedure (fast). The last connection will be marked as invalid, due to adding/removing profile. 2) If profile exists, the device will try to connect it (Up to seven profiles). 3) If fast and profiles are not found, and open mode is enabled, the device will try to connect to any AP. More...
 
long wlan_ioctl_get_scan_results (unsigned long ulScanTimeout, unsigned char *ucResults)
 Gets entry from scan result table. The scan results are returned one by one, and each entry represents a single AP found in the area. The following is a format of the scan result: More...
 
long wlan_ioctl_set_scan_params (unsigned long uiEnable, unsigned long uiMinDwellTime, unsigned long uiMaxDwellTime, unsigned long uiNumOfProbeRequests, unsigned long uiChannelMask, long iRSSIThreshold, unsigned long uiSNRThreshold, unsigned long uiDefaultTxPower, unsigned long *aiIntervalList)
 start and stop scan procedure. Set scan parameters. More...
 
long wlan_smart_config_start (unsigned long algoEncryptedFlag)
 Start to acquire device profile. The device acquire its own profile, if profile message is found. The acquired AP information is stored in CC3000 EEPROM only in case AES128 encryption is used. In case AES128 encryption is not used, a profile is created by CC3000 internally. More...
 
long wlan_smart_config_stop (void)
 Stop the acquire profile procedure. More...
 
long wlan_smart_config_set_prefix (char *cNewPrefix)
 Configure station ssid prefix. The prefix is used internally in CC3000. It should always be TTT. More...
 
long wlan_smart_config_process (void)
 process the acquired data and store it as a profile. The acquired AP information is stored in CC3000 EEPROM encrypted. The encrypted data is decrypted and stored as a profile. behavior is as defined by connection policy. More...
 

Detailed Description

Function Documentation

long wlan_add_profile ( unsigned long  ulSecType,
unsigned char *  ucSsid,
unsigned long  ulSsidLen,
unsigned char *  ucBssid,
unsigned long  ulPriority,
unsigned long  ulPairwiseCipher_Or_TxKeyLen,
unsigned long  ulGroupCipher_TxKeyIndex,
unsigned long  ulKeyMgmt,
unsigned char *  ucPf_OrKey,
unsigned long  ulPassPhraseLen 
)

When auto start is enabled, the device connects to station from the profiles table. Up to 7 profiles are supported. If several profiles configured the device choose the highest priority profile, within each priority group, device will choose profile based on security policy, signal strength, etc parameters. All the profiles are stored in CC3000 NVMEM.

wlan_add_profile

Parameters
ulSecTypeWLAN_SEC_UNSEC,WLAN_SEC_WEP,WLAN_SEC_WPA,WLAN_SEC_WPA2
ucSsidssid SSID up to 32 bytes
ulSsidLenssid length
ucBssidbssid 6 bytes
ulPriorityulPriority profile priority. Lowest priority:0.
ulPairwiseCipher_Or_TxKeyLenkey length for WEP security
ulGroupCipher_TxKeyIndexkey index
ulKeyMgmtKEY management
ucPf_OrKeysecurity key
ulPassPhraseLensecurity key length for WPA/WPA2
Returns
On success, zero is returned. On error, -1 is returned
See Also
wlan_ioctl_del_profile
long wlan_connect ( unsigned long  ulSecType,
char *  ssid,
long  ssid_len,
unsigned char *  bssid,
unsigned char *  key,
long  key_len 
)

Connect to AP.

wlan_connect

Parameters
ulSecTypesecurity options: WLAN_SEC_UNSEC, WLAN_SEC_WEP (ASCII support only), WLAN_SEC_WPA or WLAN_SEC_WPA2
ssidup to 32 bytes and is ASCII SSID of the AP
ssid_lenlength of the SSID
bssid6 bytes specified the AP bssid
keyup to 16 bytes specified the AP security key
key_lenkey length
Returns
On success, zero is returned. On error, negative is returned. Note that even though a zero is returned on success to trigger connection operation, it does not mean that CCC3000 is already connected. An asynchronous "Connected" event is generated when actual association process finishes and CC3000 is connected to the AP. If DHCP is set, An asynchronous "DHCP" event is generated when DHCP process is finish.
Warning
Please Note that when connection to AP configured with security type WEP, please confirm that the key is set as ASCII and not as HEX.
See Also
wlan_disconnect
Examples:
mqtt_wifi_publisher.c, mqtt_wifi_subscriber.c, wifi_tcp_client.c, wifi_tcp_client_server.c, and wifi_tcp_server.c.
long wlan_disconnect ( void  )

Disconnect connection from AP.

wlan_disconnect

Returns
0 disconnected done, other CC3000 already disconnected
See Also
wlan_connect
void wlan_init ( tWlanCB  sWlanCB,
tFWPatches  sFWPatches,
tDriverPatches  sDriverPatches,
tBootLoaderPatches  sBootLoaderPatches,
tWlanReadInteruptPin  sReadWlanInterruptPin,
tWlanInterruptEnable  sWlanInterruptEnable,
tWlanInterruptDisable  sWlanInterruptDisable,
tWriteWlanPin  sWriteWlanPin 
)

Initialize wlan driver.

wlan_init

Parameters
sWlanCBAsynchronous events callback. 0 no event call back. -call back parameters: 1) event_type: HCI_EVNT_WLAN_UNSOL_CONNECT connect event, HCI_EVNT_WLAN_UNSOL_DISCONNECT disconnect event, HCI_EVNT_WLAN_ASYNC_SIMPLE_CONFIG_DONE config done, HCI_EVNT_WLAN_UNSOL_DHCP dhcp report, HCI_EVNT_WLAN_ASYNC_PING_REPORT ping report OR HCI_EVNT_WLAN_KEEPALIVE keepalive. 2) data: pointer to extra data that received by the event (NULL no data). 3) length: data length. -Events with extra data: HCI_EVNT_WLAN_UNSOL_DHCP: 4 bytes IP, 4 bytes Mask, 4 bytes default gateway, 4 bytes DHCP server and 4 bytes for DNS server. HCI_EVNT_WLAN_ASYNC_PING_REPORT: 4 bytes Packets sent, 4 bytes Packets received, 4 bytes Min round time, 4 bytes Max round time and 4 bytes for Avg round time.
sFWPatches0 no patch or pointer to FW patches
sDriverPatches0 no patch or pointer to driver patches
sBootLoaderPatches0 no patch or pointer to bootloader patches
sReadWlanInterruptPininit callback. the callback read wlan interrupt status.
sWlanInterruptEnableinit callback. the callback enable wlan interrupt.
sWlanInterruptDisableinit callback. the callback disable wlan interrupt.
sWriteWlanPininit callback. the callback write value to device pin.
Returns
none
See Also
wlan_set_event_mask , wlan_start , wlan_stop
Warning
This function must be called before ANY other wlan driver function
Examples:
mqtt_wifi_publisher.c, mqtt_wifi_subscriber.c, wifi_tcp_client.c, wifi_tcp_client_server.c, and wifi_tcp_server.c.
long wlan_ioctl_del_profile ( unsigned long  ulIndex)

Delete WLAN profile.

wlan_ioctl_del_profile

Parameters
ulIndexnumber of profile to delete
Returns
On success, zero is returned. On error, -1 is returned
Note
In order to delete all stored profile, set index to 255.
See Also
wlan_add_profile
long wlan_ioctl_get_scan_results ( unsigned long  ulScanTimeout,
unsigned char *  ucResults 
)

Gets entry from scan result table. The scan results are returned one by one, and each entry represents a single AP found in the area. The following is a format of the scan result:

wlan_ioctl_get_scan_results

Parameters
ulScanTimeout[in] parameter not supported
ucResults[out]scan result (_wlan_full_scan_results_args_t)
Returns
On success, zero is returned. On error, -1 is returned
     - 4 Bytes: number of networks found
    - 4 Bytes: The status of the scan: 0 - aged results,
               1 - results valid, 2 - no results
    - 42 bytes: Result entry, where the bytes are arranged as  follows:

                    - 1 bit isValid - is result valid or not
                - 7 bits rssi - RSSI value;  
           - 2 bits: securityMode - security mode of the AP:
                     0 - Open, 1 - WEP, 2 WPA, 3 WPA2
                - 6 bits: SSID name length
                - 2 bytes: the time at which the entry has entered into 
                      scans result table
                - 32 bytes: SSID name
           - 6 bytes:   BSSID 
Note
scan_timeout, is not supported on this version.
See Also
wlan_ioctl_set_scan_params

wlan_ioctl_get_scan_results

Parameters
[in]ulScanTimeoutparameter not supported
[out]ucResultsscan results (_wlan_full_scan_results_args_t)
Returns
On success, zero is returned. On error, -1 is returned
     - 4 Bytes: number of networks found
    - 4 Bytes: The status of the scan: 0 - aged results,
               1 - results valid, 2 - no results
    - 42 bytes: Result entry, where the bytes are arranged as  follows:

                    - 1 bit isValid - is result valid or not
                - 7 bits rssi - RSSI value;  
           - 2 bits: securityMode - security mode of the AP:
                     0 - Open, 1 - WEP, 2 WPA, 3 WPA2
                - 6 bits: SSID name length
                - 2 bytes: the time at which the entry has entered into 
                      scans result table
                - 32 bytes: SSID name
           - 6 bytes:   BSSID 
Note
scan_timeout, is not supported on this version.
See Also
wlan_ioctl_set_scan_params
long wlan_ioctl_set_connection_policy ( unsigned long  should_connect_to_open_ap,
unsigned long  ulShouldUseFastConnect,
unsigned long  ulUseProfiles 
)

When auto is enabled, the device tries to connect according the following policy: 1) If fast connect is enabled and last connection is valid, the device will try to connect to it without the scanning procedure (fast). The last connection will be marked as invalid, due to adding/removing profile. 2) If profile exists, the device will try to connect it (Up to seven profiles). 3) If fast and profiles are not found, and open mode is enabled, the device will try to connect to any AP.

wlan_ioctl_set_connection_policy

Parameters
should_connect_to_open_apenable(1), disable(0) connect to any available AP. This parameter corresponds to the configuration of item # 3 in the brief description.
ulShouldUseFastConnectenable(1), disable(0). if enabled, tries to connect to the last connected AP. This parameter corresponds to the configuration of item # 1 in the brief description.
ulUseProfilesenable(1), disable(0) auto connect after reset and periodically reconnect if needed. This configuration configures option 2 in the above description.
Returns
On success, zero is returned. On error, -1 is returned
        * Note that the policy settings are stored in the CC3000 NVMEM.
See Also
wlan_add_profile , wlan_ioctl_del_profile

set connection policy

Parameters
should_connect_to_open_apenable(1), disable(0) connect to any available AP. This parameter corresponds to the configuration of item # 3 in the brief description.
ulShouldUseFastConnectenable(1), disable(0). if enabled, tries to connect to the last connected AP. This parameter corresponds to the configuration of item # 1 in the brief description.
ulUseProfilesenable(1), disable(0) auto connect after reset and periodically reconnect if needed. This configuration configures option 2 in the above description.
Returns
On success, zero is returned. On error, -1 is returned
        * Note that the policy settings are stored in the CC3000 NVMEM.
See Also
wlan_add_profile , wlan_ioctl_del_profile
long wlan_ioctl_set_scan_params ( unsigned long  uiEnable,
unsigned long  uiMinDwellTime,
unsigned long  uiMaxDwellTime,
unsigned long  uiNumOfProbeRequests,
unsigned long  uiChannelMask,
long  iRSSIThreshold,
unsigned long  uiSNRThreshold,
unsigned long  uiDefaultTxPower,
unsigned long *  aiIntervalList 
)

start and stop scan procedure. Set scan parameters.

wlan_ioctl_set_scan_params

Parameters
uiEnable- start/stop application scan: 1 = start scan with default interval value of 10 min. in order to set a different scan interval value apply the value in milliseconds. minimum 1 second. 0=stop). Wlan reset (wlan_stop() wlan_start()) is needed when changing scan interval value. Saved: No
uiMinDwellTimeminimum dwell time value to be used for each channel, in milliseconds. Saved: yes Recommended Value: 100 (Default: 20)
uiMaxDwellTimemaximum dwell time value to be used for each channel, in milliseconds. Saved: yes Recommended Value: 100 (Default: 30)
uiNumOfProbeRequestsmax probe request between dwell time. Saved: yes. Recommended Value: 5 (Default:2)
uiChannelMaskbitwise, up to 13 channels (0x1fff). Saved: yes. Default: 0x7ff
iRSSIThresholdRSSI threshold. Saved: yes (Default: -80)
uiSNRThresholdNSR threshold. Saved: yes (Default: 0)
uiDefaultTxPowerprobe Tx power. Saved: yes (Default: 205)
aiIntervalListpointer to array with 16 entries (16 channels) each entry (unsigned long) holds timeout between periodic scan (connection scan) - in milliseconds. Saved: yes. Default 2000ms.
Returns
On success, zero is returned. On error, -1 is returned
Note
uiDefaultTxPower, is not supported on this version.
See Also
wlan_ioctl_get_scan_results

wlan_ioctl_set_scan_params

Parameters
uiEnable- start/stop application scan: 1 = start scan with default interval value of 10 min. in order to set a different scan interval value apply the value in milliseconds. minimum 1 second. 0=stop). Wlan reset (wlan_stop() wlan_start()) is needed when changing scan interval value. Saved: No
uiMinDwellTimeminimum dwell time value to be used for each channel, in milliseconds. Saved: yes Recommended Value: 100 (Default: 20)
uiMaxDwellTimemaximum dwell time value to be used for each channel, in milliseconds. Saved: yes Recommended Value: 100 (Default: 30)
uiNumOfProbeRequestsmax probe request between dwell time. Saved: yes. Recommended Value: 5 (Default:2)
uiChannelMaskbitwise, up to 13 channels (0x1fff). Saved: yes. Default: 0x7ff
iRSSIThresholdRSSI threshold. Saved: yes (Default: -80)
uiSNRThresholdNSR threshold. Saved: yes (Default: 0)
uiDefaultTxPowerprobe Tx power. Saved: yes (Default: 205)
aiIntervalListpointer to array with 16 entries (16 channels) each entry (unsigned long) holds timeout between periodic scan (connection scan) - in millisecond. Saved: yes. Default 2000ms.
Returns
On success, zero is returned. On error, -1 is returned
Note
uiDefaultTxPower, is not supported on this version.
See Also
wlan_ioctl_get_scan_results
long wlan_ioctl_statusget ( void  )

get wlan status: disconnected, scanning, connecting or connected

wlan_ioctl_statusget

Returns
WLAN_STATUS_DISCONNECTED, WLAN_STATUS_SCANING, STATUS_CONNECTING or WLAN_STATUS_CONNECTED
Examples:
mqtt_wifi_publisher.c, mqtt_wifi_subscriber.c, wifi_tcp_client.c, wifi_tcp_client_server.c, and wifi_tcp_server.c.
long wlan_set_event_mask ( unsigned long  ulMask)

Mask event according to bit mask. In case that event is masked (1), the device will not send the masked event to host.

wlan_set_event_mask

Parameters
ulMaskmask option: HCI_EVNT_WLAN_UNSOL_CONNECT connect event HCI_EVNT_WLAN_UNSOL_DISCONNECT disconnect event HCI_EVNT_WLAN_ASYNC_SIMPLE_CONFIG_DONE smart config done HCI_EVNT_WLAN_UNSOL_INIT init done HCI_EVNT_WLAN_UNSOL_DHCP dhcp event report HCI_EVNT_WLAN_ASYNC_PING_REPORT ping report HCI_EVNT_WLAN_KEEPALIVE keepalive HCI_EVNT_WLAN_TX_COMPLETE - disable information on end of transmission Saved: no.
Returns
On success, zero is returned. On error, -1 is returned
Examples:
mqtt_wifi_publisher.c, mqtt_wifi_subscriber.c, wifi_tcp_client.c, wifi_tcp_client_server.c, and wifi_tcp_server.c.
long wlan_smart_config_process ( void  )

process the acquired data and store it as a profile. The acquired AP information is stored in CC3000 EEPROM encrypted. The encrypted data is decrypted and stored as a profile. behavior is as defined by connection policy.

wlan_smart_config_process

Returns
On success, zero is returned. On error, -1 is returned
long wlan_smart_config_set_prefix ( char *  cNewPrefix)

Configure station ssid prefix. The prefix is used internally in CC3000. It should always be TTT.

wlan_smart_config_set_prefix

Parameters
cNewPrefix3 bytes identify the SSID prefix for the Smart Config.
Returns
On success, zero is returned. On error, -1 is returned
Note
The prefix is stored in CC3000 NVMEM
See Also
wlan_smart_config_start , wlan_smart_config_stop
long wlan_smart_config_start ( unsigned long  algoEncryptedFlag)

Start to acquire device profile. The device acquire its own profile, if profile message is found. The acquired AP information is stored in CC3000 EEPROM only in case AES128 encryption is used. In case AES128 encryption is not used, a profile is created by CC3000 internally.

wlan_smart_config_start

Parameters
algoEncryptedFlagindicates whether the information is encrypted
Returns
On success, zero is returned. On error, -1 is returned
Note
An asynchronous event - Smart Config Done will be generated as soon as the process finishes successfully.
See Also
wlan_smart_config_set_prefix , wlan_smart_config_stop
long wlan_smart_config_stop ( void  )

Stop the acquire profile procedure.

wlan_smart_config_stop

Returns
On success, zero is returned. On error, -1 is returned
See Also
wlan_smart_config_start , wlan_smart_config_set_prefix
void wlan_start ( unsigned short  usPatchesAvailableAtHost)

Start WLAN device. This function asserts the enable pin of the device (WLAN_EN), starting the HW initialization process. The function blocked until device Initialization is completed. Function also configure patches (FW, driver or bootloader) and calls appropriate device callbacks.

wlan_start

Parameters
usPatchesAvailableAtHost- flag to indicate if patches available from host or from EEPROM. Due to the fact the patches are burn to the EEPROM using the patch programmer utility, the patches will be available from the EEPROM and not from the host.
Returns
none
Note
Prior calling the function wlan_init shall be called.
Warning
This function must be called after wlan_init and before any other wlan API
See Also
wlan_init , wlan_stop
Examples:
mqtt_wifi_publisher.c, mqtt_wifi_subscriber.c, wifi_tcp_client.c, wifi_tcp_client_server.c, and wifi_tcp_server.c.
void wlan_stop ( void  )

Stop WLAN device by putting it into reset state.

wlan_stop

Returns
none
See Also
wlan_start