{"type":"doc","content":[{"type":"layoutSection","marks":[{"type":"breakout","attrs":{"mode":"wide"}}],"content":[{"type":"layoutColumn","attrs":{"width":66.66},"content":[{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"networkstatus","type":"text","marks":[{"type":"em"}]},{"text":" component provides access to the current networking status of the player. It provides the current state as opposed to the intended configuration. For example, ","type":"text"},{"text":"the current IP addresses assigned to network interfaces can be retrieved from networkstatus when the player is configured to use DHCP.","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":" This component can be used to determine the actual IP addresses and other network settings that are currently active.","type":"text"}]},{"type":"paragraph","content":[{"text":"networkstatus IDL","type":"text","marks":[{"type":"annotation","attrs":{"annotationType":"inlineComment","id":"b61266e3-0c67-4651-a56b-44bf264706d9"}},{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"[\n Constructor()\n] interface NetworkStatus {\n Promise getHostStatus();\n Promise getDiagnosticWebServerStatus();\n Promise getRemoteLoginStatus();\n Promise getInterfaceStatus(string interfaceName);\n Promise getInterfaceWifiStatus(string interfaceName);\n Promise> getPresentNetworkInterfaces();\n Promise> getRoutes(string protocol); // \"IPv4\" or \"IPv6\"\n};\n\ninterface NetworkHostStatus {\n attribute string hostName;\n attribute string mDnsHostName;\n\n attribute Array domainSearchPath;\n attribute Array domainNameServers;\n attribute Array timeServers;\n attribute string? proxy;\n attribute Array? proxyBypass;\n\n attribute string? crashUrl;\n attribute string? errorUrl;\n attribute string? recoveryUrl;\n};\n\ninterface DiagnosticWebServerStatus {\n attribute short? port;\n};\n\ninterface RemoteLoginStatus {\n attribute unsigned short? telnetPort; // Not present if not enabled\n attribute unsigned short? sshPort; // Not present if not enabled\n};\n\ninterface NetworkInterfaceStatus {\n attribute string? type;\n attribute bool present; // Interface is actually present (e.g. WiFi may be configured but removed)\n attribute string presentStatus;\n attribute bool? hasLink;\n attribute string? macAddress;\n attribute bool? isVlan; // This interface is itself a VLAN\n attribute short? vlanTag;\n attribute string? parentInterface; // The underlying physical interface for a VLAN\n attribute Array? vlanChildTagList; // VLANs on this interface. Includes zero for untagged.\n attribute Array? ipAddressList; // Includes all IPv4 and IPv6 addresses\n attribute long? inboundShaperRate;\n attribute Array? domainSearchPath;\n attribute Array? domainNameServers;\n};\n\ninterface NetworkStatusIpAddress {\n attribute string family; // \"IPv4\" or \"IPv6\"\n attribute string scope;\n attribute string? address; // \"172.30.1.30\" or \"fd44:d8b8:cab5:cb01::19\"\n attribute string? netmask; // IPv4 only\n attribute string? broadcast; // IPv4 only\n attribute int? prefixLength; // IPv4 and IPv6\n attribute string? cidr; // Address with prefix length in CIDR notation\n};\n\ninterface WifiInterfaceStatus {\n attribute string mode; // \"AP\" or \"STA\"\n attribute bool? connected; // (Not present in AP mode.)\n attribute string? essid;\n attribute string? bssid; // (Not present in AP mode.)\n attribute string? frequency; // In MHz to match other APIs\n attribute int? signalStrength; // In dBm\n};\n\ninterface NetworkStatusRoute {\n attribute string destination; // or \"default\"\n attribute string? source;\n attribute int metric;\n attribute Array nextHops;\n};\n\ninterface NetworkStatusNextHop {\n attribute string? gateway;\n attribute string? interface;\n} ","type":"text"}]}]},{"type":"layoutColumn","attrs":{"width":33.33},"content":[{"type":"bodiedExtension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"panel","parameters":{"macroParams":{"borderColor":{"value":"#3D3D3D"},"bgColor":{"value":"#F4F4F4"},"titleColor":{"value":"#3D3D3D"},"borderWidth":{"value":"0"},"titleBGColor":{"value":"#3D3D3D"},"borderStyle":{"value":"solid"}},"macroMetadata":{"macroId":{"value":"6041596c-97c4-48dc-8f94-eb2b1d949b1e"},"schemaVersion":{"value":"1"},"title":"Panel"}},"localId":"2cf7afd2-dac4-42f6-bf56-0b04b1ec1fb3"},"content":[{"type":"paragraph","content":[{"text":"ON THIS PAGE","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"indent":{"value":"20px"}},"macroMetadata":{"macroId":{"value":"47b4ce7e-9563-4cd5-98e4-28fa04ea1bea"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"bf04f247-d2e8-46c1-8817-0f1c6562fcff"}}]},{"type":"paragraph","content":[{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Object Creation","type":"text"}]},{"type":"paragraph","content":[{"text":"To create a ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"networkstatus","type":"text","marks":[{"type":"em"}]},{"text":" component, load the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"@brightsign/networkstatus","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}},{"type":"em"}]},{"text":" module using the ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]},{"text":"require()","type":"text","marks":[{"type":"code"}]},{"text":" method. ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#000000"}}]}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"const NetworkStatus = require(\"@brightsign/networkstatus\");\nlet networkStatus = new NetworkStatus();","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"NetworkStatus","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"getHostStatus()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise getHostStatus() ","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns information about the network status of the player as a whole.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"getDiagnosticWebServerStatus()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise getDiagnosticWebServerStatus() ","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns information about the status of the diagnostic web server.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"getRemoteLoginStatus()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise getRemoteLoginStatus() ","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns information about the status of the player related to remote shell access.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"getInterfaceStatus()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise getInterfaceStatus(string interfaceName)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns information about the current status of the specified network interface.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"getInterfaceWifiStatus()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise getInterfaceWifiStatus(string interfaceName)","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns information about the current WiFi status of the specified wireless network interface.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"getPresentNetworkInterfaces()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise> getPresentNetworkInterfaces()","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns an array containing the names of all the external network interfaces present on the player. Does not include the loopback interface.","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"getRoutes()","type":"text"}]},{"type":"codeBlock","attrs":{"language":"javascript"},"content":[{"text":"Promise> getRoutes(string protocol); // \"IPv4\" or \"IPv6\"","type":"text"}]},{"type":"paragraph","content":[{"text":"Returns an array of the current network routes for the specified protocol.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"NetworkHostStatus","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hostName","type":"text","marks":[{"type":"code"}]},{"text":" string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": The player's current host name.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"mDnsHostName","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": The player's current Multicast DNS host name. This will usually be the player's host name with \".local\" on the end, but can differ if there are conflicts on the local network.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"domainSearchPath","type":"text","marks":[{"type":"code"}]},{"text":" Array","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": A list of suffices that will be applied to unqualified domain names when looking them up in DNS. This is the combination of the search paths for all active network interfaces.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"domainNameServers","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"Array","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": A list of the current DNS servers that will be consulted when performing name look ups. This is the combination of all the DNS servers for all active network interfaces.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timeServers","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"Array","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": A list of the current time servers that will be used to set the player's clock. Currently this will contain either zero or one entry, but it may contain more in the future.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"proxy","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": The currently active network proxy server, if any.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"proxyBypass","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"Array ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": A list of host name suffices for which the proxy will be bypassed (IP addresses cannot be used)","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"crashUrl","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": The URL to which player crash dumps will be posted, if any.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"errorUrl","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": The URL to which BrightScript errors will be posted, if any.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"recoveryUrl","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": The URL which will be consulted to determine whether the player should enter recovery, if any.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"DiagnosticWebServerStatus","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"port","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"short","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": The port number that the web server will be run on. If the web server is disabled then this attribute will not be present.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"RemoteLoginStatus","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"telnetPort","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"unsigned","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"short","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": The port number that the player will listen to telnet connections on. If telnet is not enabled then this attribute will not be present.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"sshPort","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"unsigned","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"short","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": The port number that the player will listen for secure shell connections on. If ssh is not enabled then this attribute will not be present.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"NetworkInterfaceStatus","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": If the interface is present, this attribute will contain \"Wired\", \"WiFi\", \"Dialup\" or \"Unknown\". Note that some USB network devices may appear to the BrightSign player to be of one type when they are actually a different type. For example, some broadband modems appear as \"Wired\" Ethernet devices.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"present","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": Indicates whether the specified network interface is currently present on the player.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"presentStatus","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": Provides extra human-readable information explaining why the interface is not present. For example, a VLAN interface may not have been enabled on its corresponding physical interface.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hasLink","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": Indicates whether the network interface currently has link","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"macAddress","type":"text","marks":[{"type":"code"}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": Contains the hardware MAC address for network interfaces that have one.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"isVlan","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": Indicates whether this network interface is a VLAN on another lower network interface.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"vlanTag","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"short","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": If this interface is a VLAN, this attribute contains the tag value that will be used on the lower interface.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"parentInterface","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": If this interface is a VLAN, this attribute contains the name of the lower interface that packets will be sent on.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"vlanChildTagList","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"Array ","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": If this network interface has VLAN interfaces running above it then this array contains all of their tag values. The special tag value of zero indicates that this interface is also used itself untagged.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"ipAddressList","type":"text","marks":[{"type":"code"}]},{"text":" Array","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": A list of all IPv4 and IPv6 addresses assigned to this network interface.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"inboundShaperRate","type":"text","marks":[{"type":"code"}]},{"text":" long","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": If an inbound bandwidth shaper is enabled for this interface, this attribute contains the rate in bits per second.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"domainSearchPath","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"Array","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": A list of suffices that this network interface contributes to the host configuration when this network interface is active. See NetworkHostStatus.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"domainNameServers","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"Array","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": A list of DNS servers that this network interface contributes to the host configuration when this network interface is active. See NetworkHostStatus.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"NetworkStatusIpAddress","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"family","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": Contains the address family: \"IPv4\" or \"IPv6\"","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"scope","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": Mainly useful for IPv6 addresses, this attribute indicates the scope of the address. Possible values are \"global\", \"site\", \"link\", \"host\" and \"nowhere\".","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"address","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": The actual address as a string.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"netmask","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": For IPv4 addresses only this attribute contains the prefix length expressed as a traditional netmask.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"broadcast","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": For IPv4 addresses only this attribute contains the network broadcast address.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"prefixLength","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"int","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": For IPv4 and IPv6 addresses this attribute contains the number of bits of the address that are used to identify the network.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"cidr ","type":"text","marks":[{"type":"code"}]},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": For IPv4 and IPv6 addresses this attribute contains the address and prefix length in classless inter-domain routing (CIDR) syntax: address/prefix.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"WifiInterfaceStatus","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"mode","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": Indicates which mode the WiFi interface is currently in. When in \"AP\" mode the interface is acting as a wireless access point for other wireless devices to connect to. In \"STA\" mode the interface is acting as a client to another wireless access point.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"connected","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": If the interface is in \"STA\" mode, indicates whether the interface is connected to an access point. In \"AP\" mode this attribute is not present.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"essid","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": If the interface is in \"STA\" mode, indicates the ESSID of the AP that the interface is connected to. In \"AP\" mode, indicates the ESSID that the wireless interface is advertising for clients to connect to.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"bssid","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": If the interface is in \"STA\" mode, indicates the BSSID of the AP that the interface is connected to. In \"AP\" mode this attribute is not present.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"frequency","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": The frequency that the wireless interface radio is currently using, in MHz.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"signalStrength","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"int","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": The current signal strength, in dBm.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"NetworkStatusRoute","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"destination","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": The route destination or \"default\" for the default route.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"metric","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"int","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": The priority for the route. Lower priority routes are preferred.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"nextHops","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"Array","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":": A list of where packets subject to this route will be sent next. This list currently contains only one element.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"NetworkStatusNextHop","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"gateway","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": The address to which packets will be sent.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"interface","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"},{"text":"string","type":"text","marks":[{"type":"textColor","attrs":{"color":"#6554c0"}}]},{"text":" ","type":"text"},{"text":"optional","type":"text","marks":[{"type":"textColor","attrs":{"color":"#00b8d9"}}]},{"text":": The network interface on which packets will be sent. ","type":"text"}]}]}]},{"type":"paragraph","content":[{"type":"hardBreak"},{"type":"hardBreak"}]},{"type":"paragraph","content":[{"type":"hardBreak"}]}],"version":1}

Browser not supported