networkdiagnostics
The networkdiagnostics object allows you to retrieve information about network interfaces and Internet connectivity.
networkdiagnostics IDL
interface NetworkDiagnostics {
Promise<NetworkDiagnosticsResult> testInternetConnectivity()
Promise<NetworkDiagnotsticsResult> testNetworkInterface(String interface_name)
Promise<PingResult> ping(String host_name, PingConfig config)
Promise<TracerouteResult> traceroute(String host_name, TracerouteConfig config)
//< For BrightSign internal use. Behaviour subject to change without notice.
};
interface InterfaceTestResult {
String diagnosis;
bool ok;
Array<Log> log;
};
interface Log {
String name;
bool pass;
String result;
Array<String> info;
//< For BrightSign internal use. Behaviour subject to change without notice.
};
interface PingConfig {
unsigned? short count; // default 10
unsigned long? interval; // in milliseconds, default 100
unsigned long? timeout; // in seconds, default 10000
unsigned long? packetsize; // in bytes, default 56
bool? ipv4; // enable pinging IPv4 addresses, default true
bool? ipv6; // enable pinging IPv6 addresses, default false
bool? allAddresses; // if true then ping all addresses returned from DNS query,
// if false then each will be pinged in turn until one responds, default false
};
interface PingResult {
String hostname; // host name or literal address pinged
PingResults results;
};
interface PingResults {
bool up; // true if at least one address responded to at least 50% of the echo requests
Array<ProtocolPingResult>? ipv4;
Array<ProtocolPingResult>? ipv6;
};
interface ProtocolPingResult {
String address; // IP address pinged
bool up; // true if the address responded to at least 50% of the echo requests
ProtocolPingReport report;
};
interface ProtocolPingReport {
unsigned short transmitted; // number of echo requests sent
unsigned short received; // number of echo replies received
ProtocolPingStats stats;
};
interface ProtocolPingStats {
unsigned long quickest; // quickest reply received
unsigned long average; // average time across all replies from address
unsigned long slowest; // slowest reply received
String units; // always "us" to indicate microseconds
};
Object Creation
To create a networkdiagnostics object, first load the brightsign/networkdiagnostics
 module using the require()
 method. Then create an instance of the networkdiagnostics class.
var NetworkDiagnosticsClass = require("@brightsign/networkdiagnostics");
var networkDiag = new NetworkDiagnosticsClass();
NetworkDiagnostics
Use this interface to retrieve diagnostic information.
Important
The testInternetConnectivity() method generates a large amount of network traffic (e.g. DNS lookups) that may degrade the performance of a player, create network congestion, or be perceived as abusive by the network's upstream DNS provider. This method is intended for one-time use to validate network connectivity or to diagnose a suspected problem.Â
testInternetConnectivity()
Promise<InterfaceTestResult> testInternetConnectivity()
Performs various tests on the Internet connection (via any available network interface) to determine whether it appears to be working correctly. This method returns an InterfaceTestResult
 interface when diagnostics are complete.
testNetworkInterface()
Performs tests on the specified network interface to determine whether it appears to be working correctly. Interface name values are the same as those used with the roNetworkConfiguration object. This method returns an InterfaceTestResult
 interface when diagnostics are complete.
ping()
Pings a device with the specified host_name
to determine if there are connection issues.Â
traceroute()
For BrightSign internal use. Behavior subject to change without notice. Performs a standard traceroute diagnostic on the specified host_name
.
InterfaceTestResult
This interface contains diagnostic results:
diagnosis
String: Â A single-line diagnosis of the first problem identified with the network interface or Internet connectionok
bool: A Boolean flag indicating whether the network interface or Internet connection passed diagnostic testslog
Log: A Log object containing diagnostic information related to the network interface or Internet connection
Log
This interface contains a list of diagnostic logs. Each log contains the following attributes:
name
: String: A description of the diagnosticÂpass
bool: A Boolean flag indicating whether the diagnostic was successfulresult
String: A description of the diagnostic resultinfo
StringList: A string list containing diagnostic data
PingConfig
This interface is not recommended unless you are using BrightSign OS v8.3.45 and later.
count
unsigned short: The default value is 10.interval
unsigned long:Â The interval value in milliseconds. The default is 100.timeout
 unsigned long: The timeout value in seconds. The default is 10000.packetsize
unsigned long: The packet size in bytes. The default is 56.ipv4
bool: Â Enable pinging IPv4 addresses. The default isÂtrue
.ipv6
bool:  Enable pinging IPv6 addresses. The default isÂtrue
.allAddresses
bool: Â IfÂtrue
 then ping all addresses returned from the DNS query. IfÂfalse,
 then each will be pinged in turn until one responds. The default isÂfalse
.
PingResult
This interface is not recommended unless you are using BrightSign OS v8.3.45 and later.
hostname
String: Â The host name or literal address pinged.results
PingResults:
PingResults
This interface is not recommended unless you are using BrightSign OS v8.3.45 and later.
up
bool: Â This value isÂtrue
 if at least one address responded to at least 50% of the echo requests.ipv4
Array<ProtocolPingResult>:ipv6
Array<ProtocolPingResult>:
ProtocolPingResult
This interface is not recommended unless you are using BrightSign OS v8.3.45 and later.
address
string:Â Â The IP address pingedup
 bool: IfÂtrue,
 the address responded to at least 50% of the echo requestsreport
ProtocolPingReport:
ProtocolPingReport
This interface is not recommended unless you are using BrightSign OS v8.3.45 and later.
transmitted
unsigned short:Â The number of echo requests sentreceived
unsigned short:Â Â The number of echo replies receivedstats
ProtocolPingStats:
ProtocolPingStats
This interface is not recommended unless you are using BrightSign OS v8.3.45 and later.
quickest
unsigned long: The quickest reply receivedaverage
unsigned long: Â The average time across all replies from addressslowest
unsigned long: Â The slowest reply receivedunits
string:Â The value is always "us", to indicate microseconds
Example
The following script creates a networkdiagnostics instance and logs Internet diagnostic data to the console: