Telematics SDK - API Reference
v1.64.0
|
Data Structures | |
struct | telux::wlan::ApVenueInfo |
struct | telux::wlan::ApSecurity |
struct | telux::wlan::ApElementInfoConfig |
struct | telux::wlan::ApNetConfig |
struct | telux::wlan::ApConfig |
struct | telux::wlan::DeviceIndInfo |
struct | telux::wlan::DeviceInfo |
class | telux::wlan::IApInterfaceManager |
Manager class for configuring Wlan Access Points. More... | |
class | telux::wlan::IApListener |
Macros | |
#define | INVALID_AP_ID 0 |
This section contains APIs related to access point configuration management, such as private/guest, internet/local access, etc.
struct telux::wlan::ApVenueInfo |
struct telux::wlan::ApSecurity |
AP Security
Data Fields | ||
---|---|---|
SecMode | mode |
Security mode |
SecAuth | auth |
Authorization method |
SecEncrypt | encrypt |
Encryption method |
struct telux::wlan::ApElementInfoConfig |
AP Element Info
Data Fields | ||
---|---|---|
bool | isEnabled | |
bool | isInterworkingEnabled |
Interworking Service enablement |
NetAccessType | netAccessType |
Network Access Type |
bool | internet |
Whether network provide connectivity to internet |
bool | asra |
Additional step required for access |
bool | esr |
Emergency services reachable |
bool | uesa |
Unauthenticated emergency service accessible |
uint8_t | venueGroup |
Venue group |
uint8_t | venueType |
Venue type |
string | hessid |
Homogeneous ESS identifier |
string | vendorElements |
Vendor elements for Beacon and Probe Response frames |
string | assocRespElements |
Vendor elements for (Re)Association Response frames |
struct telux::wlan::ApNetConfig |
Ap Network Configuration
Data Fields | ||
---|---|---|
ApInfo | info |
AP type |
string | ssid |
SSID for AP |
bool | isVisible |
AP broadcast SSID |
ApElementInfoConfig | elementInfoConfig |
AP broadcast it's capabilities (Such as CarPlay) |
ApInterworking | interworking |
AP network access (internet/local) |
ApSecurity | apSecurity |
AP Security settings |
string | passPhrase |
Passphrase for SSID used |
struct telux::wlan::ApConfig |
Ap Configuration
Data Fields | ||
---|---|---|
Id | id |
AP id |
ApVenueInfo | venue |
AP venue info |
vector< ApNetConfig > | network |
Configurations supported by AP |
struct telux::wlan::DeviceIndInfo |
Wlan Client Device Indication Info
Data Fields | ||
---|---|---|
Id | id |
AP id device is connected to |
string | macAddress |
MAC Address of Wi-Fi device |
struct telux::wlan::DeviceInfo |
Wlan Client Device Info
Data Fields | ||
---|---|---|
Id | id |
AP id device is connected to |
string | name |
User friendly string that identifies Wi-Fi device |
string | ipv4Address |
IPv4 Address of Wi-Fi device |
vector< string > | ipv6Address |
List of IPv6 Addresses of Wi-Fi device |
string | macAddress |
MAC Address of Wi-Fi device |
class telux::wlan::IApInterfaceManager |
Manager class for configuring Wlan Access Points.
class telux::wlan::IApListener |
Public Member Functions | |
virtual void | onApDeviceStatusChanged (ApDeviceConnectionEvent event, std::vector< DeviceIndInfo > info) |
virtual void | onApBandChanged (BandType radio) |
virtual void | onApConfigChanged (Id apId) |
virtual | ~IApListener () |
#define INVALID_AP_ID 0 |
|
strong |
|
strong |
|
strong |
|
strong |
Wlan Authentication Method
|
strong |
|
strong |
AP Network Access Type
|
pure virtual |
Set Access Point config: Used to fully configure access points including venue type, radio type (2.4/5 GHz), private/guest network and all other related settings. Configurations will take effect after hostapd service is restarted by calling telux::wlan::IApInterfaceManager::manageApService.
On platforms with Access control enabled, Caller needs to have TELUX_WLAN_AP_CONFIG permission to invoke this API successfully.
[in] | config | AP configuration parameters telux::wlan::ApConfig |
|
pure virtual |
Set Wlan Security Configuration: Used to change security settings of selected network.
[in] | apId | AP identifier to set security for. telux::wlan::Id |
[in] | apSecurity | AP security settings. telux::wlan::ApSecurity |
|
pure virtual |
Set Access Point SSID: Used to change SSID of selected network.
[in] | apId | AP identifier to set SSID for. telux::wlan::Id |
[in] | ssid | new SSID to be set |
|
pure virtual |
Set Access Point visibility: Used to change SSID broadcast of selected network.
[in] | apId | AP identifier to set SSID visibility for. telux::wlan::Id |
[in] | isVisible | Visibility to be set |
|
pure virtual |
Configure Element Info: Used to change element info configurations of selected network.
[in] | apId | AP identifier to enable element info on. telux::wlan::Id |
[in] | config | Element Info configurations. |
On platforms with Access control enabled, Caller needs to have TELUX_WLAN_AP_DEVICES permission to invoke this API successfully.
|
pure virtual |
Set Passphrase for Access Point: Used to change passphrase of selected network.
[in] | apId | AP identifier to set passphrase for. telux::wlan::Id |
[in] | passPhrase | new passPhrase string |
|
pure virtual |
Request Access Point Configurations
[in] | config | Vector of AP configurations telux::wlan::ApConfig as set by telux::wlan::IApInterfaceManager::setConfig |
|
pure virtual |
Request AP Status
[in] | status | Vector of AP network Status telux::wlan::ApStatus |
|
pure virtual |
Request Connected Devices to all enabled access points. Each entry in returned list will contain information about a device such as access point it is connected to and IP and MAC address as defined in telux::wlan::DeviceInfo
On platforms with Access control enabled, Caller needs to have TELUX_WLAN_AP_DEVICES permission to invoke this API successfully.
[in] | clientsInfo | List of connected devices Info telux::wlan::DeviceInfo |
|
pure virtual |
Execute an operation on hostapd service. Provides ability for client to either stop/start or restart hostapd service for selected access point. Restarting hostapd service is required for any changes made to hostapd.conf file and changes made by telux::wlan::IApInterfaceManager::setConfig to take effect. Stop/Start operation telux::wlan::ServiceOperation will Stop/Start WiFi service for access point. Access points selected to execute operation on, will temporarily go out of service when this API is called. This API should be called only when access point is configured through
On platforms with Access control enabled, Caller needs to have TELUX_WLAN_AP_CONFIG permission to invoke this API successfully.
telux::wlan::IDeviceManager::setMode
[in] | apId | AP identifier to execute operation on. telux::wlan::Id |
[in] | opr | Operation to be performed on hostapd telux::wlan::ServiceOperation |
|
pure virtual |
Register a listener for specific events in Access Point Manager
[in] | listener | pointer of IApListener object that processes the notification |
|
pure virtual |
Removes a previously added listener.
[in] | listener | pointer of IApListener object that needs to be removed |
|
virtual |
|
virtual |
This function is called when AP device status has changed
[in] | event | Event detected on device telux::wlan::ApDeviceConnectionEvent |
[in] | info | Info about devices telux::wlan::DeviceIndInfo |
|
virtual |
This function is called when AP switch to different operation band
[in] | radio | New AP operation band telux::wlan::BandType |
|
virtual |
This function is called when AP configuration has changed
[in] | apid | telux::wlan::Id of Ap it's configuration has changed |
|
virtual |
int telux::wlan::ApVenueInfo::type |
Venue Type
int telux::wlan::ApVenueInfo::group |
Venue Group
SecMode telux::wlan::ApSecurity::mode |
Security mode
SecAuth telux::wlan::ApSecurity::auth |
Authorization method
SecEncrypt telux::wlan::ApSecurity::encrypt |
Encryption method
bool telux::wlan::ApElementInfoConfig::isEnabled |
bool telux::wlan::ApElementInfoConfig::isInterworkingEnabled |
Interworking Service enablement
NetAccessType telux::wlan::ApElementInfoConfig::netAccessType |
Network Access Type
bool telux::wlan::ApElementInfoConfig::internet |
Whether network provide connectivity to internet
bool telux::wlan::ApElementInfoConfig::asra |
Additional step required for access
bool telux::wlan::ApElementInfoConfig::esr |
Emergency services reachable
bool telux::wlan::ApElementInfoConfig::uesa |
Unauthenticated emergency service accessible
uint8_t telux::wlan::ApElementInfoConfig::venueGroup |
Venue group
uint8_t telux::wlan::ApElementInfoConfig::venueType |
Venue type
std::string telux::wlan::ApElementInfoConfig::hessid |
Homogeneous ESS identifier
std::string telux::wlan::ApElementInfoConfig::vendorElements |
Vendor elements for Beacon and Probe Response frames
std::string telux::wlan::ApElementInfoConfig::assocRespElements |
Vendor elements for (Re)Association Response frames
ApInfo telux::wlan::ApNetConfig::info |
AP type
std::string telux::wlan::ApNetConfig::ssid |
SSID for AP
bool telux::wlan::ApNetConfig::isVisible |
AP broadcast SSID
ApElementInfoConfig telux::wlan::ApNetConfig::elementInfoConfig |
AP broadcast it's capabilities (Such as CarPlay)
ApInterworking telux::wlan::ApNetConfig::interworking |
AP network access (internet/local)
ApSecurity telux::wlan::ApNetConfig::apSecurity |
AP Security settings
std::string telux::wlan::ApNetConfig::passPhrase |
Passphrase for SSID used
Id telux::wlan::ApConfig::id |
AP id
ApVenueInfo telux::wlan::ApConfig::venue |
AP venue info
std::vector<ApNetConfig> telux::wlan::ApConfig::network |
Configurations supported by AP
Id telux::wlan::DeviceIndInfo::id |
AP id device is connected to
std::string telux::wlan::DeviceIndInfo::macAddress |
MAC Address of Wi-Fi device
Id telux::wlan::DeviceInfo::id |
AP id device is connected to
std::string telux::wlan::DeviceInfo::name |
User friendly string that identifies Wi-Fi device
std::string telux::wlan::DeviceInfo::ipv4Address |
IPv4 Address of Wi-Fi device
std::vector<std::string> telux::wlan::DeviceInfo::ipv6Address |
List of IPv6 Addresses of Wi-Fi device
std::string telux::wlan::DeviceInfo::macAddress |
MAC Address of Wi-Fi device