Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

Panel
borderColor#3D3D3D
bgColor#F4F4F4
titleColor#3D3D3D
borderWidth0
titleBGColor#3D3D3D
borderStylesolid

ON THIS PAGE

Table of Contents
indent20px

...

If the network_interface is specified as an integer, the interface must currently exist on the player; otherwise, the object-creation function will return Invalid. Conversely, specifying the network_interface as a string allows you to create a roNetworkConfiguration instance for an interface that is not currently present on the player.

The network interface can be configured as a VLAN using the following string format: "[parent_interface].[vlan_id]" (e.g "eth0.42"). Once the VLAN interface(s) are configured, they must be enabled on the parent network interface (e.g. "eth0") using the SetVlanIds() method. VLAN interfaces use DHCP by default. They are supported on Series 4 (XTx44, XDx34, HDx24, LS424) and Series 3 (XTx43, XDx33, HDx23, LS423, HO523) players only.

Code Block
titleExample
 n6 = CreateObject("roNetworkConfiguration", "eth0.6")

 


Some of the settings below are specific to the network interface, while others are used by the BrightSign host for all network interfaces.

...

Note
titleNote

Contact support@brightsign.biz to learn more about generating a key for obfuscation and storing it on the player.

SetWiFiFrequencies(frequencies As String) As Boolean

Sets valid WiFi frequencies to specified range. Supports 2 GHz("2GHz"), 5 GHz("5GHz"), or list of frequencies written in MHz("2412 2417"). It returns true if the frequency is successfully set.

SetWiFiAccessPointMode(enable as Boolean) As Boolean

...

CAtype

NENA

PIDF

Description

Examples

0

 

 



language

i-default [3]

16

PRD

PRD

leading street direction

N

17

POD

POD

trailing street suffix

SW

18

STS

STS

street suffix

Ave, Platz

19

HNO

HNO

house number

123

20

HNS

HNS

house number suffix

A, 1/2

21

LMK

LMK

landmark or vanity address

Columbia University

22

LOC

LOC

additional location information

South Wing

23

NAM

NAM

name (residence and office occupant)

Joe's Barbershop

24

ZIP

PC

postal/ZIP code

10027-1234

25

 

 



building (structure)

Low Library

26

 

 



unit (apartment, suite)

Apt 42

27

 


FLR

floor

4

28

 

 



room number

450F

29

 

 



placetype

office

30

PCN

 


postal community name

Leonia

31

 

 



post office box (P.O Box)

12345

32

 

 



additional code

13203000003

128

 

 



script

Latn

255 

 



reserved

 


ifWiFiConfiguration

ScanWiFi() As roArray

...

Code Block
nc = CreateObject("roNetworkConfiguration", 1)
nc.SetWiFiSecurityMode("")
nc.SetWiFiESSID("")
nc.SetWiFiIdentity("")
nc.SetWiFiCaCertificates("")
nc.SetWiFiClientCertificate("")
nc.SetWiFiPrivateKey("")
nc.SetWiFiPassphrase("")
nc.SetWiFiEapTlsOptions("")
ok = nc.Apply()

 


The following script configures the WiFi for EAP-TLS using a PKCS#12 (.p12) file, without additional CA certificates:

Code Block
essid = "brightwifi"
pkcs12file = "client.p12"
pkcspass = "passwordgoeshere"

nc = CreateObject("roNetworkConfiguration", 1)
nc.SetWiFiESSID(essid)

p12 = CreateObject("roByteArray")
ok = p12.ReadFile(pkcs12file)

if ok then
    nc.SetWiFiClientCertificate("")
    nc.SetWiFiPrivateKey(p12)
    nc.SetWiFiPassphrase(pkcspass)

    nc.SetWiFiCaCertificates("")
    nc.SetWiFiSecurityMode("")
    nc.SetWiFiIdentity("")
    nc.SetWiFiEapTlsOptions("")

    ok = nc.Apply()
end if

 


The following script configures the WiFi for EAP-TLS with additional certificates:

Code Block
essid = "brightwifi"
cafile = "cacert.pem"
pkcs12file = "client.p12"
pkcspass = "passwordgoeshere"

nc = CreateObject("roNetworkConfiguration", 1)
nc.SetWiFiESSID(essid)

p12 = CreateObject("roByteArray")
ok = p12.ReadFile(pkcs12file)

ca = CreateObject("roByteArray")
ok = ca.ReadFile(cafile) and ok

if ok then
    nc.SetWiFiClientCertificate("")
    nc.SetWiFiPrivateKey(p12)
    nc.SetWiFiPassphrase(pkcspass)

    nc.SetWiFiCaCertificates("")
    nc.SetWiFiSecurityMode("")
    nc.SetWiFiIdentity("")
    nc.SetWiFiEapTlsOptions("")

    ok = nc.Apply()
end if

 


The following script configures the WiFi for PEAP/MSCHAP with additional CA files:

Code Block
essid = "brightwifi"
cafile = "ca.pem"
user = "someuser@brightsign.biz"
pass = "whatever"
ca = CreateObject("roByteArray")
ok = ca.ReadFile(cafile)

if ok then
    nc = CreateObject("roNetworkConfiguration", 1)
    nc.SetWiFiESSID(essid)
    nc.SetWiFiIdentity(user)
    nc.SetWiFiPassphrase(pass)
    nc.SetWiFiCaCertificates(ca)
    nc.SetWiFiClientCertificate("")
    nc.SetWiFiPrivateKey("")
    'Use this if an anonymous outer identity is required
    'nc.SetWiFiEapTlsOptions("anonymous_identity=anon@brightsign.biz")
    nc.SetWiFiEapTlsOptions("")

    ok = nc.Apply()
    if not ok then
        fail = "Unable to set configuration: " + nc.GetFailureReason()
    end if
else
    fail = "Unable to read file " + cafile
end if

' if not ok, do something with the failure message

...


The following script performs various VLAN configurations on the Ethernet interface:

...