POST /system/network/adapters/wireless/primary/hotspot
This turns the controller into a Wi-Fi hotspot with a router. This puts the hotspot into a separate subnetwork with a DHCP server to provide IP addresses to any connected device.
Wide area network (WAN) connectivity is through the wired connection. Though BACnet/IP uses IP protocol to communicate, this hotspot acts as an IP router; it does not forward broadcast messages which are important in BACnet to identify services that are available within the BACnet internetwork.
All fields are optional.
The values sent are saved but the mode is not applied.
If the encryption node is present, all the child values are required according to the type. Only the WPA2 mode is available.
<span class="glyphicon glyphicon-warning-sign" aria-hidden="true"> Some values are shared with the access-point mode. If you want to pre-set the values for one or both modes, you must take note that a change to the values of one will change the values of the other.
The values affected are:
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
There are multiple possible values according the resource:
If this parameter is not present during the request, and error 415 Unsupported Media Type will be thrown.
The Content-Length entity-header field indicates the size of the entity-body.
Object Name: Encryption
| Property Name | Type | Description | Method |
|---|---|---|---|
| Type | String | This property references the type of the encryption. There are multiple encryption types:
|
GET POST |
| Password | String | This property is the password of the encryption. The password value need to be encoded in Base64. When encryption is used, set the password to access the Wi-Fi network as a client or the password other clients will use to access this hotspot. Passwords should be a long series of random alphanumeric characters and symbols that are hard to guess. This parameter is case sensitive. For the type WPA2E, the password is that of the user. |
GET POST |
| Username | String | This property represents the user's name that can be connected to the network. | GET POST |
| EAP | String | This property is EAP, it's the network communication protocol. It's used to connect to an enterprise network that has a working RADIUS authentication server. The possible values are :
|
GET POST |
| Phase2 | String | This property is the phase 2 authentication, used to connect to an enterprise network that has a working RADIUS authentication server. The possible values are :
|
GET POST |
Object Name: Advanced
| Property Name | Type | Description | Method |
|---|---|---|---|
| ChannelNumber | Object | This object represents the channel number. This sets the center frequency of the transmission. If there are other Wi-Fi networks are nearby, configure each Wi-Fi network to use different channel numbers to reduce interference and network drop-outs. |
GET POST |
| WifiMode | String | This object sets the wireless mode (wireless G or wireless N). Wireless N mode is backwards compatible with Wireless G and B. Wireless G mode is backwards compatible with Wireless B. A mesh network uses the wireless N mode. |
GET POST |
Object Name: ChannelNumber
| Property Name | Type | Description | Method |
|---|---|---|---|
| Id | Integer | This property is the id of a channel number. Lists of the ID :
|
GET POST |
| Value | String | This property is the channel number value. Lists of the values :
|
GET |
Object Name: Hotspot
| Property Name | Type | Description | Method |
|---|---|---|---|
| Encryption | Object | This object represents the encryption details. It can be multiple type of encryption possible. Each encryption type need different properties. | GET POST |
| Advanced | Object | This object represents the advanced values you can configure for a Wi-Fi connection. | GET POST |
| NetworkName | String | This property is the name of the Wi-Fi network (SSID). The size limit is 32 char. (Except for the client mode) |
GET POST |
| IpAddress | String | This property is the IP address for this hotspot (or gateway address that wireless clients will connect to). Ensure that this address is:
|
GET POST |
| SubnetMask | String | This property is the hotspot’s subnetwork mask. | GET POST |
| FirstAddress | String | This defines the range of IP addresses to be made available for hotspot clients to use. The narrower the range, the fewer hotspot clients will be able to connect due to the lack of available IP addresses. For example, a range where First Address = 192.168.0.22 and Last Address = 192.168.0.26 will allow a maximum of 5 clients to connect to the hotspot on a first-to-connect basis. | GET POST |
| LastAddress | String | This defines the range of IP addresses to be made available for hotspot clients to use. The narrower the range, the fewer hotspot clients will be able to connect due to the lack of available IP addresses. For example, a range where First Address = 192.168.0.22 and Last Address = 192.168.0.26 will allow a maximum of 5 clients to connect to the hotspot on a first-to-connect basis. | GET POST |
URL Example: https://0.0.0.0/api/rest/v1/system/network/adapters/wireless/primary/hotspot
{
"networkName": "EclypseNetworkName",
"ipAddress": "192.168.1.1",
"subnetMask": "255.255.255.0",
"firstAddress": "192.168.1.2",
"lastAddress": "192.168.1.50",
"encryption": {
"type": "WPA2",
"password": "Y3pOamRYSmxVR0Z6YzNkdmNtUT0="
},
"advanced": {
"channelNumber": {
"id": 6
},
"wifiMode": "G"
}
}
URL Example: https://0.0.0.0/api/rest/v1/system/network/adapters/wireless/primary/hotspot
<?xml version="1.0" encoding="utf-8"?>
<Hotspot>
<NetworkName>EclypseNetworkName</NetworkName>
<Encryption>
<Type>WPA2</Type>
<Password>czNjdXJlUGFzc3dvcmQ=</Password>
</Encryption>
<IpAddress>192.168.1.1</IpAddress>
<SubnetMask>255.255.255.0</SubnetMask>
<FirstAddress>192.168.1.2</FirstAddress>
<LastAddress>192.168.1.50</LastAddress>
<Advanced>
<ChannelNumber>
<Id>2</Id>
</ChannelNumber>
<WifiMode>G</WifiMode>
</Advanced>
</Hotspot>