| Panel | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
ON THIS PAGE
|
...
Use this interface to configure a network interface on the player.
getConfig()
| Code Block | ||
|---|---|---|
| ||
Promise<NetworkInterfaceConfig> getConfig(NetworkInterfaceConfigRequestParams params[optional]) |
Returns configuration settings for the network interface. Depending on the specified type, this method will return an EthernetInterfaceConfig, WiFiInterfaceConfig, or ModemInterfaceConfig interface. If there is a set password, getConfig() will return true for the password parameter. If there isn't a set password, getConfig() will return false for the password parameter.
Note that this class concerns itself with the player's persistent network configuration. If you wish to determine the current settings (for example the IP address that has been retrieved via DHCP) then use the Node.js os module.
applyConfig()
| Code Block | ||
|---|---|---|
| ||
Promise<void> applyConfig(NetworkInterfaceConfig config) |
...
The config parameter should contain the complete desired configuration. Any previous configuration is overwritten. If you wish to change one item while keeping the rest of the configuration the same then first call getConfig and modify the returned object (see the example in the Examples section).
getNeighborInformation()
| Code Block | ||
|---|---|---|
| ||
Promise<LLDPNeighborInformation> getNeighborInformation() |
Returns LLDP information related to the network. This method is available with the ethernet interface only.
enableLeds()
| Code Block | ||
|---|---|---|
| ||
Promise<void> enableLeds() |
Enables or disables the ethernet activity LEDs (that is, flashing during link and activity behavior). Ethernet LEDs are enabled by default. Changes to this setting do not persist across reboots. This method is available with the ethernet interface only.
scan()
| Code Block | ||
|---|---|---|
| ||
Promise<WifiAccessPointList> scan() |
Scans for WiFi access points are returns a list of detected access points. This method is available with the WiFi interface only.
Attributes
[String] type: The network interface type, which can one of the following:"eth0": The ethernet port on the BrightSign player"wlan0": The internal WiFi"ppp0": A connected modem
| Tip | ||
|---|---|---|
| ||
The network interface can be configured as a VLAN using the following string format: |
WifiAccessPointList
This interface represents the results of a scan for wireless networks. Each entry in the list contains the following parameters:
[String] essId: the WiFi ESSId network name[String] bssId: the BSSID of the access point[long] signal: The received signal strength. The absolute value of this attribute is usually not relevant, but it can be compared with the reported value on other networks or in different locations.
...
[long] metric: The routing metric for the default gateway on the interface. Routes with lower metrics are preferred over routes with higher metrics.[DHCPServerConfig] dhcpServerConfig: A DHCPServerConfig interface that specifies the DHCP server configuration for the interface. The DHCP server can be disabled by setting this attribute to a null value when callingapplyConfig().[Array<String>] dnsServerList: A string list containing a maximum of three DNS servers. Each string should contain the dotted-quad IP address of a DNS server.[Array<IPAddress>] ipAddressList: An array containing zero or one static IPv4 address configurations. Players do not currently support more than one IPv4 address per interface or static configuration of IPv6 addresses. If the array is empty then IP addresses will be assigned using DHCP.[long] inboundShaperRate: If defined, the bandwidth limit for inbound traffic in bits per second. If undefined, there is no bandwidth limit.Note title Note Because of overhead on the shaping algorithm, attempting to limit the bandwidth at rates greater than approximately 2Mbit/s will reduce speeds to less than the specified rate.
[long] mtu: The maximum transmission unit (MTU) for the network interface in bytes[Array<int>] vlanIdList: A list of VLAN IDs that this network interface is the parent for.[String] clientIdentifier: The DHCP client identifier for the network interface[String] domain: The domain name for the network interface[Array<String>] enabledProtocolList: An optional array containing the set of enabled IP protocols. The default value is [IPv4,IPv6].
DialUpInterfaceConfig
This interface contains attributes related to the modem interface:
[String] user:[String] password:[String] number:[String] initString:
...
[String] securityMode:[String] identity:The RADIUS identity. If this value is blank, it will be taken from the specified client certificate ("subjectAltName" will be used if present; otherwise, the "commonName" is used).[String] eapTlsOptions:A string containing EAP-specific options[String] caCertificates:The contents of a CA certificate file in text form (that is, a "pem" file)[String] clientCertificate:The contents of a client certificate file in text form (that is, a "pem" file)[String] privateKey:The private key for authentication
WifiInterfaceConfig
This interface contains attributes related to the WiFi interface:
...