NetworkInfoProvider

Outgoing Messages

GetWifiSignalStrength

Requests the signal strength (RSSI) of the WiFi connection on the platform.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "NetworkInfoProvider",
            "action": "GetWifiSignalStrength"
        }
    }
}

GetNetworkStatus

Requests the network connection status on the platform.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "NetworkInfoProvider",
            "action": "GetNetworkStatus"
        }
    }
}

Incoming Messages

NetworkStatusChanged

Notifies the Engine of a network status change on the platform.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Publish",
        "id": {{String}},
        "messageDescription": {
            "topic": "NetworkInfoProvider",
            "action": "NetworkStatusChanged"
        }
    },
    "payload": {
        "status": {{NetworkStatus}},
        "wifiSignalStrength": {{Int}}        
    }
}

Payload

Property	Type	Required	Description	Example
status	NetworkStatus	Yes	The connection status	CONNECTED
wifiSignalStrength	Int	Yes	The RSSI of the WiFi connection.

GetWifiSignalStrengthReply

Reply for GetWifiSignalStrength message.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Reply",
        "id": {{String}},
        "messageDescription": {
            "topic": "NetworkInfoProvider",
            "action": "GetWifiSignalStrength",
            "replyToId": {{String}}        
        }
    },
    "payload": {
        "wifiSignalStrength": {{Int}}        
    }
}

Payload

Property	Type	Required	Description	Example
wifiSignalStrength	Int	Yes	The RSSI of the WiFi connection.

GetNetworkStatusReply

Reply for GetNetworkStatus message.

JSON Structure

{
    "header": {
        "version": "4.0",
        "messageType": "Reply",
        "id": {{String}},
        "messageDescription": {
            "topic": "NetworkInfoProvider",
            "action": "GetNetworkStatus",
            "replyToId": {{String}}        
        }
    },
    "payload": {
        "status": {{NetworkStatus}}        
    }
}

Payload

Property	Type	Required	Description	Example
status	NetworkStatus	Yes	The network connection status

Enums

NetworkStatus

Values

Value	Description
"UNKNOWN"	The network status is unknown
"DISCONNECTED"	The network is disconnected.
"DISCONNECTING"	The network is disconnecting
"CONNECTED"	The network is connected
"CONNECTING"	The network is connecting