Telematics SDK - API Reference
v1.54.0
|
Modules | |
Telematics_wlan_ap | |
Data Structures | |
struct | telux::wlan::ApNetConfig |
struct | telux::wlan::ApConfig |
struct | telux::wlan::DeviceInfo |
struct | telux::wlan::DeviceStats |
class | telux::wlan::IStaInterfaceManager |
Manager class for configuring Wlan Station Mode. More... | |
class | telux::wlan::IStaListener |
struct | telux::wlan::ApInfo |
struct | telux::wlan::ApNetInfo |
struct | telux::wlan::ApStatus |
struct | telux::wlan::StaStatus |
struct | telux::wlan::InterfaceStatus |
class | telux::wlan::IWlanDeviceManager |
WlanDeviceManager is a primary interface for configuring Wireless LAN. it provide APIs to enable, configure, activate, and modify modes. More... | |
class | telux::wlan::IWlanListener |
class | telux::wlan::WlanFactory |
WlanFactory is the central factory to create all wlan classes. More... | |
Macros | |
#define | INVALID_AP_ID 0 |
Variables | |
ApInfo | telux::wlan::ApNetConfig::info |
ApInterworking | telux::wlan::ApNetConfig::interworking |
Id | telux::wlan::ApConfig::id |
std::vector< ApNetConfig > | telux::wlan::ApConfig::network |
Id | telux::wlan::DeviceInfo::id |
std::string | telux::wlan::DeviceInfo::name |
std::string | telux::wlan::DeviceInfo::ipv4Address |
std::string | telux::wlan::DeviceInfo::ipv6Address |
std::string | telux::wlan::DeviceInfo::macAddress |
Id | telux::wlan::DeviceStats::id |
std::string | telux::wlan::DeviceStats::macAddress |
uint64_t | telux::wlan::DeviceStats::bytesTx |
uint64_t | telux::wlan::DeviceStats::bytesRx |
HwDeviceType | telux::wlan::InterfaceStatus::device |
std::vector< ApStatus > | telux::wlan::InterfaceStatus::apStatus |
std::vector< StaStatus > | telux::wlan::InterfaceStatus::staStatus |
struct telux::wlan::ApNetConfig |
Ap Network Configuration
Data Fields | ||
---|---|---|
ApInfo | info |
AP type |
ApInterworking | interworking |
AP network access (internet/local) |
struct telux::wlan::ApConfig |
Ap Configuration
Data Fields | ||
---|---|---|
Id | id |
AP id |
vector< ApNetConfig > | network |
Configurations supported by AP |
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 |
string | ipv6Address |
IPv6 Address of Wi-Fi device |
string | macAddress |
MAC Address of Wi-Fi device |
struct telux::wlan::DeviceStats |
Wlan Client Device Statistics
Data Fields | ||
---|---|---|
Id | id |
AP id device is connected to |
string | macAddress |
MAC Address of Wi-Fi device |
uint64_t | bytesTx |
Number of bytes transmitted |
uint64_t | bytesRx |
Number of bytes received |
class telux::wlan::IStaInterfaceManager |
Manager class for configuring Wlan Station Mode.
Public Member Functions | |
virtual telux::common::ErrorCode | setIpConfig (Id staId, StaIpConfig ipConfig, StaStaticIpConfig staticIpConfig)=0 |
virtual telux::common::ErrorCode | setBridgeMode (Id staId, StaBridgeMode bridgeMode)=0 |
virtual telux::common::ErrorCode | getConfig (std::vector< StaConfig > &config)=0 |
virtual telux::common::ErrorCode | getStatus (std::vector< StaStatus > &status)=0 |
virtual telux::common::ErrorCode | manageStaService (Id staId, ServiceOperation opr)=0 |
virtual telux::common::ErrorCode | registerListener (std::weak_ptr< IStaListener > listener)=0 |
virtual telux::common::ErrorCode | deregisterListener (std::weak_ptr< IStaListener > listener)=0 |
virtual | ~IStaInterfaceManager () |
class telux::wlan::IStaListener |
Public Member Functions | |
virtual void | onStationStatusChanged (std::vector< StaStatus > staStatus) |
virtual void | onStationBandChanged (BandType radio) |
virtual | ~IStaListener () |
struct telux::wlan::ApInfo |
AP Info - captures ap type (private/guest)
Data Fields | ||
---|---|---|
ApType | apType |
Ap type (private/guest) |
struct telux::wlan::ApNetInfo |
Ap Network Info
Data Fields | ||
---|---|---|
ApInfo | info |
Ap information (AP type) |
struct telux::wlan::ApStatus |
struct telux::wlan::StaStatus |
Station Status
Data Fields | ||
---|---|---|
Id | id |
Station Id |
string | name |
Network interface name |
string | ipv4Address |
Public IP V4 address |
string | ipv6Address |
Public IP V6 address |
string | macAddress |
MAC address |
StaInterfaceStatus | status |
Interface status |
struct telux::wlan::InterfaceStatus |
Wlan Interface status
Data Fields | ||
---|---|---|
HwDeviceType | device | |
vector< ApStatus > | apStatus |
Vector of active APs status |
vector< StaStatus > | staStatus |
Vector of active Sta status |
class telux::wlan::IWlanDeviceManager |
WlanDeviceManager is a primary interface for configuring Wireless LAN. it provide APIs to enable, configure, activate, and modify modes.
Public Member Functions | |
virtual telux::common::ServiceStatus | getServiceStatus ()=0 |
virtual telux::common::ErrorCode | enable (bool enable)=0 |
virtual telux::common::ErrorCode | setMode (int numOfAp, int numOfSta)=0 |
virtual telux::common::ErrorCode | getConfig (int &numAp, int &numSta)=0 |
virtual telux::common::ErrorCode | getStatus (bool &isEnabled, std::vector< InterfaceStatus > &status)=0 |
virtual telux::common::ErrorCode | registerListener (std::weak_ptr< IWlanListener > listener)=0 |
virtual telux::common::ErrorCode | deregisterListener (std::weak_ptr< IWlanListener > listener)=0 |
virtual | ~IWlanDeviceManager () |
class telux::wlan::IWlanListener |
Public Member Functions | |
virtual void | onServiceStatusChange (telux::common::ServiceStatus status) |
virtual void | onEnableChanged (bool enable) |
virtual | ~IWlanListener () |
class telux::wlan::WlanFactory |
WlanFactory is the central factory to create all wlan classes.
Public Member Functions | |
virtual std::shared_ptr< IWlanDeviceManager > | getWlanDeviceManager (telux::common::InitResponseCb clientCallback=nullptr)=0 |
virtual std::shared_ptr< IApInterfaceManager > | getApInterfaceManager ()=0 |
virtual std::shared_ptr< IStaInterfaceManager > | getStaInterfaceManager ()=0 |
Static Public Member Functions | |
static WlanFactory & | getInstance () |
Protected Member Functions | |
WlanFactory () | |
virtual | ~WlanFactory () |
|
protected |
|
protectedvirtual |
|
static |
Get Wlan Factory instance.
|
pure virtual |
Get Wlan Device Manager
[in] | clientCallback | Optional callback to get the initialization status of WlanDeviceManager telux::common::InitResponseCb |
|
pure virtual |
Get Access Point Interface Manager
|
pure virtual |
Get Station Interface Manager
#define INVALID_AP_ID 0 |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
|
strong |
Station Interface Status
|
strong |
This applies in architectures where the modem is attached to an External Application Processor(EAP). An API that sets or configure Wlan can be invoked from the EAP or from the modems Internal Application Processor (IAP). This type specifies where the operation should be carried out.
Enumerator | |
---|---|
WLAN_LOCAL |
Perform the operation on the processor where the API is invoked. |
WLAN_REMOTE |
Perform the operation on the application processor other than where the API is invoked. |
|
strong |
|
strong |
|
strong |
|
strong |
|
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 |
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 |
Request statistics for all devices connected to all access points. Each entry in returned list will contains transmitted and recieved bytes for a device as defined in telux::common::DeviceStats
On platforms with Access control enabled, Caller needs to have TELUX_WLAN_AP_DEVICES permission to invoke this API successfully.
[in] | clientStats | List of connected clients statistics telux::wlan::DeviceStats |
|
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 hosapd.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::DeviceInfo |
|
virtual |
This function is called when AP switch to different operation band
[in] | radio | New AP operation band telux::wlan::BandType |
|
virtual |
|
pure virtual |
Checks the readiness status of wlan manager and returns the result.
|
pure virtual |
Enable or Disable Wlan Service. Configurations set by telux::wlan::IWlanDeviceManager::setMode must be completed before enabling Wlan. If any of configurations need to be changed after Wlan is enabled, this API must be called with enable set to false followed by a call with enable set to true for the new configurations to take effect. Calling this API with enable, will start hostapd and wpa_supplicant daemons. Further changes to hostapd and wpa_supplicant will require calling telux::wlan::IApInterfaceManager::manageApService and telux::wlan::IStaInterfaceManager::manageStaService respectively. Client shall wait for IWlanListener::onEnableChanged indication to confirm WLAN was enabled/disabled successfully
On platforms with Access control enabled, Caller needs to have TELUX_WLAN_DEVICE_CONFIG permission to invoke this API successfully.
[in] | enable | true : Enable Wlan, false: Disable Wlan. |
|
pure virtual |
Set Wlan mode - number of supported APs, and stations. This API shall be called when wlan is disabled. On enablement, wlan will enable APs and Stations set in this API.
[in] | numOfAp | Num of Access Points to be enabled. If no Access Point is enabled, this argument should be set to 0. Configuration of each AP is accomplished through telux::data::wlan::IApManager instance requested from factory. |
[in] | numOfSta | Num of Stations to be enabled. If no station is enabled, this argument should be set to 0. Configuration of each Station is accomplished through telux::data::wlan::IStaManager instance requested from factory. |
On platforms with Access control enabled, Caller needs to have TELUX_WLAN_DEVICE_CONFIG permission to invoke this API successfully.
|
pure virtual |
Request Wlan configuration: Returns the configuration that was set using telus::wlan::IWlanDeviceManager::setMode. This might differ from what configuration is has actually been enabled in the system, for instance, when the hardware cannot fully support the configuration that was set. To get the status of current configuration an Wlan enablement, telux::wlan::IWlanDeviceManager::getStatus should be used.
[in] | numAp | Num of configured APs |
[in] | numSta | Num of configured Stations |
|
pure virtual |
Request Wlan status: Return Wlan enablement status and Interface status of APs and Station such as active/inactive, network interface name and hardware device they are mapped to. Results are valid only if Wlan is enabled.
[in] | isEnabled | true: Wlan is enabled. false: Wlan is Disabled. |
[in] | status | vector of interface status InterfaceStatus. |
|
pure virtual |
Register a listener for specific events in the Wlan Manager
[in] | listener | pointer of IWlanListener object that processes the notification |
|
pure virtual |
Removes a previously added listener.
[in] | listener | pointer of IWlanListener object that needs to be removed |
|
virtual |
Destructor for IWlanDeviceManager
|
virtual |
This function is called when service status changes.
[in] | status | - ServiceStatus |
|
virtual |
This function is called when Wlan enablement has changed
[in] | enable | True: Wlan is enabled, False: Wlan is disabled |
|
virtual |
ApInfo telux::wlan::ApNetConfig::info |
AP type
ApInterworking telux::wlan::ApNetConfig::interworking |
AP network access (internet/local)
Id telux::wlan::ApConfig::id |
AP id
std::vector<ApNetConfig> telux::wlan::ApConfig::network |
Configurations supported by AP
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::string telux::wlan::DeviceInfo::ipv6Address |
IPv6 Address of Wi-Fi device
std::string telux::wlan::DeviceInfo::macAddress |
MAC Address of Wi-Fi device
Id telux::wlan::DeviceStats::id |
AP id device is connected to
std::string telux::wlan::DeviceStats::macAddress |
MAC Address of Wi-Fi device
uint64_t telux::wlan::DeviceStats::bytesTx |
Number of bytes transmitted
uint64_t telux::wlan::DeviceStats::bytesRx |
Number of bytes received
HwDeviceType telux::wlan::InterfaceStatus::device |
std::vector<ApStatus> telux::wlan::InterfaceStatus::apStatus |
WiFi hardware type
Vector of active APs status
std::vector<StaStatus> telux::wlan::InterfaceStatus::staStatus |
Vector of active Sta status