Hotspot

SCPI Commands :

CONFigure:WLAN:SIGNaling<instance>:CONNection:HOTSpot:HSSPar
CONFigure:WLAN:SIGNaling<instance>:CONNection:HOTSpot:MNDigits
CONFigure:WLAN:SIGNaling<instance>:CONNection:HOTSpot:HSPar

class HotspotCls[source]

Hotspot commands group definition. 7 total commands, 4 Subgroups, 3 group commands

class HsparStruct[source]

Structure for setting input parameters. Fields:

Access_Net_Type: enums.AccessNetType: PNETwork | PNWGaccess | CPNetwork | FPNetwork | PDNetwork | ESONetwork | TOEXperiment | WILDcard PNETwork: private network PNWGaccess: private network with guest access CPNetwork: chargeable public network FPNetwork: free public network PDNetwork: personal device network ESONetwork: emergency services only network TOEXperiment: test or experimental WILDcard: wildcard
Venue_Group: float: numeric | UNSPecified | ASSembly | BUSiness | EDUCational | FAINdustrial | INSTitutional | MERCantile | RESidential | STORage | UAMisc | VEHicular | OUTDoor FAINdustrial: factory and industrial UAMisc: utility and miscellaneous
Venue_Type: float: numeric Range: 0 to 255
He_Ssid: float: numeric Homogeneous extended service set identifier Range: #H0 to #HFFFFFFFFFFFF
Venue_Name: str: string String with up to 252 ASCII characters
Mcc: int: numeric Mobile country code of 3GPP network reachable via the hotspot To configure more than one PLMN, use [CMDLINKRESOLVED Configure.Connection.Hotspot.Plmn#set CMDLINKRESOLVED]. Range: 1 to 999
Mnc: int: numeric Mobile network code of 3GPP network reachable via the hotspot To configure more than one PLMN, use [CMDLINKRESOLVED Configure.Connection.Hotspot.Plmn#set CMDLINKRESOLVED]. Range: 1 to 9991)
Domain_Name: str: string Domain name of the network operator as string To configure more than one domain name, use [CMDLINKRESOLVED Configure.Connection.Hotspot.Dname#set CMDLINKRESOLVED].
Op_Frie_Name: str: string Friendly name of the network operator as string

class HssparStruct[source]

Structure for setting input parameters. Fields:

Downlink_Speed: int: numeric Range: 0 kbit/s to 300000 kbit/s, Unit: kbit/s
Uplink_Speed: int: numeric Range: 0 kbit/s to 300000 kbit/s, Unit: kbit/s
Ip_V_6_Add_Field: enums.IpV6AddField: ATNavailable | ATAVailable | AATNknown Indicates whether an IPv6 address can be allocated to the station ATNavailable: address type not available ATAVailable: address type available AATNknown: availability of the address type is not known
Ip_V_4_Add_Field: enums.IpV6AddFieldExt: ATNavailable | PIAavailable | PRIaavailabl | SNPiaavailab | DNPiaavailab | PSNiaavailab | PDNiaavailab | AATNknown Indicates whether an IPv4 address can be allocated to the station ATNavailable: address type not available PIAavailable: public IPv4 address available PRIaavailabl: port-restricted IPv4 address available SNPiaavailab: single-NATed private IPv4 address available DNPiaavailab: double-NATed private IPv4 address available PSNiaavailab: port-restricted and single-NATed IPv4 address available PDNiaavailab: port-restricted and double-NATed IPv4 address available AATNknown: availability of the address type not known
Realm_Name: str: string Name of reachable NAI realm as string To configure more than one realm, use [CMDLINKRESOLVED Configure.Connection.Hotspot.Realm#set CMDLINKRESOLVED].
Eap_Type: enums.EapType: SIM | TTLS | AKA | APRime | TLS Supported extensible authorization protocol type EAP-SIM, EAP-TTLS, EAP-AKA, EAP-AKA’ or EAP-TLS To enable multiple EAP types, use [CMDLINKRESOLVED Configure.Connection.Hotspot.Realm#set CMDLINKRESOLVED].
Internet_Access: bool: OFF | ON Specifies whether the hotspot provides internet access
Net_Auth_Type_Ind: enums.NetAuthTypeInd: ATConditions | OESupported | HREDirection | DREDirection Network authentication type ATConditions: acceptance of terms and conditions OESupported: on-line enrollment supported HREDirection: http/https redirection DREDirection: DNS redirection

get_hspar() → HsparStruct[source]

# SCPI: CONFigure:WLAN:SIGNaling<instance>:CONNection:HOTSpot:HSPar
value: HsparStruct = driver.configure.connection.hotspot.get_hspar()

Defines basic parameters of the Hotspot 2.0 operation mode.

return:

structure: for return value, see the help for HsparStruct structure arguments.

get_hsspar() → HssparStruct[source]

# SCPI: CONFigure:WLAN:SIGNaling<instance>:CONNection:HOTSpot:HSSPar
value: HssparStruct = driver.configure.connection.hotspot.get_hsspar()

Defines supplementary parameters of the Hotspot 2.0 operation mode.

return:

structure: for return value, see the help for HssparStruct structure arguments.

get_mn_digits() → NumOfDigits[source]

# SCPI: CONFigure:WLAN:SIGNaling<instance>:CONNection:HOTSpot:MNDigits
value: enums.NumOfDigits = driver.configure.connection.hotspot.get_mn_digits()

Defines the length of the MNC of the first PLMN in Hotspot 2.0 operation mode.

return:

num_of_digits: TWDigits | THDigits TWDigits: two digits THDigits: three digits

set_hspar(value: HsparStruct) → None[source]

# SCPI: CONFigure:WLAN:SIGNaling<instance>:CONNection:HOTSpot:HSPar
structure = driver.configure.connection.hotspot.HsparStruct()
structure.Access_Net_Type: enums.AccessNetType = enums.AccessNetType.CPNetwork
structure.Venue_Group: float = 1.0
structure.Venue_Type: float = 1.0
structure.He_Ssid: float = 1.0
structure.Venue_Name: str = 'abc'
structure.Mcc: int = 1
structure.Mnc: int = 1
structure.Domain_Name: str = 'abc'
structure.Op_Frie_Name: str = 'abc'
driver.configure.connection.hotspot.set_hspar(value = structure)

Defines basic parameters of the Hotspot 2.0 operation mode.

param value:

see the help for HsparStruct structure arguments.

set_hsspar(value: HssparStruct) → None[source]

# SCPI: CONFigure:WLAN:SIGNaling<instance>:CONNection:HOTSpot:HSSPar
structure = driver.configure.connection.hotspot.HssparStruct()
structure.Downlink_Speed: int = 1
structure.Uplink_Speed: int = 1
structure.Ip_V_6_Add_Field: enums.IpV6AddField = enums.IpV6AddField.AATNknown
structure.Ip_V_4_Add_Field: enums.IpV6AddFieldExt = enums.IpV6AddFieldExt.AATNknown
structure.Realm_Name: str = 'abc'
structure.Eap_Type: enums.EapType = enums.EapType.AKA
structure.Internet_Access: bool = False
structure.Net_Auth_Type_Ind: enums.NetAuthTypeInd = enums.NetAuthTypeInd.ATConditions
driver.configure.connection.hotspot.set_hsspar(value = structure)

Defines supplementary parameters of the Hotspot 2.0 operation mode.

param value:

see the help for HssparStruct structure arguments.

set_mn_digits(num_of_digits: NumOfDigits) → None[source]

# SCPI: CONFigure:WLAN:SIGNaling<instance>:CONNection:HOTSpot:MNDigits
driver.configure.connection.hotspot.set_mn_digits(num_of_digits = enums.NumOfDigits.THDigits)

Defines the length of the MNC of the first PLMN in Hotspot 2.0 operation mode.

param num_of_digits:

TWDigits | THDigits TWDigits: two digits THDigits: three digits

Cloning the Group

# Create a clone of the original group, that exists independently
group2 = driver.configure.connection.hotspot.clone()

Subgroups