MPE2 API

Firmware Version

These API calls require firmware version v3.2.16 or later.

GET [IP Address]/api/MPE

Get software and network information about MPE2s.

Example response


{
"atten1": "1.0",
"atten2": "2.0",
"atten3": "3.0",
"atten4": "4.0",
"atten_db_max": "63.0",
"atten_rf_count": "4",
"bypass1": "1",
"bypass2": "0",
"bypass3": "1",
"bypass4": "0",
"ip_static_address": "169.254.22.29",
"ip_static_gateway": "0.0.0.0",
"ip_static_subnet": "255.255.255.0",
"dev_name": "MPEB60315-01",
"dev_serial": "MPEB60315-01",
"dev_type": "MPE",
"ether_mac": "70:B3:D5:EF:31:36",
"form_error": "",
"form_result": "ok",
"version_firmware": "3.2.16"
}



The following JSON fields indicate the success or failure of the GET or POST request.


JSON field

Response

form_error one of [ "", "ok", "fail" ]
form_result free form text description of the failure

POST [IP Address]/api/MPE

A POST request may submit any subset of the device state parameters. Any parameters submitted with a GET request are ignored.

Request template

{
"atten1" : db_str,
"atten2" : db_str,
"atten3" :  db_str,
"atten4" : db_str,
"atten_db_max" : "",
"atten_rf_count" : "",
"bypass1" : enable_bool ,
"bypass2" : enable_bool ,
"bypass3" : enable_bool ,
"bypass4" : enable_bool ,
"ip_static_address" : ip_address ,
"ip_static_gateway" : gw_address,
"ip_static_subnet" : ip_subnet_address,
"dev_name" : name_string,
"dev_serial" : "",
"dev_type" : "",
"ether_mac" : "",
"version_firmware" : ""
}


atten1 / atten2 / atten3 /atten4 (SET)

Sets the attenuation level of the RF output channels.
The "atten1"  /"atten2" / "atten3" / "atten4" values specifies which RF output channel is affected. 
The db_str value must be in the range [0 ... db_max]. The db_max is the same value that is returned by the 'atten_db_max' command.
The db_str string value is parsed using C-style sscanf format string "%u.%u" and then converted to a decimal representation. Decimal values are rounded down to the nearest half-dB. Example: "15.75" is converted to 15.5 dB.

bypass1 / bypass2 / bypass3 / bypass4 (SET)

Sets the enable state of the mpe2 bypass path for each RF output channels.
The "bypass1" / "bypass2" / "bypass3" / "bypass4" values specifies which RF output is affected.

An enable_bool value of 0 connects the RF signal through the mpe2 unit. An enable_bool value that is nonzero connects the RF signal through the mpe2 bypass path.

ip_static_address (SET)

Sets the static IP host address field of the nonvolatile device configuration memory.

The ip_address value is specified using dotted-decimal notation, i.e. x.y.z.n . The ip_address value must consist of four decimal numbers each in the range [0 ... 255], separated from each other by the period (dot) character.

ip_static_gateway (SET)

Sets the static IP gateway address field of the nonvolatile device configuration memory.
The gw_address value is specified using dotted-decimal notation, i.e. x.y.z.n . The gw_address value must consist of four decimal numbers each in the range [0 ... 255], separated from each other by the period (dot) character.

ip_static_subnet (SET)

Sets the static IP subnet address field of the nonvolatile device configuration memory.
The ip_subnet_address value is specified using dotted-decimal notation, i.e. x.y.z.n . The ip_subnet_address value must consist of four decimal numbers each in the range [0 ... 255], separated from each other by the period (dot) character.

dev_name (SET)

Sets the name field of the nonvolatile device configuration memory.
The name_string value must be a single text token that contains no whitespace characters. If name_string is missing, the name field is set to an empty string.

atten_db_max (GET)

Returns the maximum attenuation level supported by the mpe2, in dB units.

atten_rf_count (GET)

Returns the number of RF channels supported by the mpe2.

dev_serial (GET)

Returns the serial ID field of the nonvolatile device configuration memory.

dev_type (GET)

Returns the type field of the nonvolatile device configuration memory. For MPE2s, it should return "MPE".

ether_mac (GET)

Returns the Ethernet MAC address field of the nonvolatile device configuration memory. 

version_firmware (GET)

Returns the firmware version of the MPE2.