PoE Output channels¶
-
GET
/ATX/hardware/chs/
(string: index)¶ Returns the state of the PoE Channel at the respective index.
Example request:
GET /ATX/hardware/chs/ch2 HTTP/1.0 Host: 192.168.168.168 Accept: application/json, text/javascript
Example response:
HTTP/1.0 200 OK Content-Type: application/json { "_sig": "", "ch2": { "data": { "v": 185, "i": 0, "class": 0, "state": 0, "mode": 1, "port_en": 1, "port_num": 2, "port_name": "Port ID 3", "pcycl_dur": 5000 } } }
Response JSON Object: - v (integer) – PoE Channel voltage value in millivolts.
- i (integer) – PoE Channel current value in milliamps.
- class (integer) – PoE Channel Power Level Class.
- state (integer) – A boolean value to indicate if the PoE Channel is active or no-active (1:active, 0:no-active). The PoE is considered ‘active’ when is delivering power to a PD (PoE Powered Device). ‘no-active’ means no power is being delivered.
- mode (integer) – Read only boolean value to indicate if the PoE Channel status (1-enable, 0-disable).
- port_en (integer) – A Read/Write boolean value to enable or disable the PoE Channel (1-enable, 0-disable).
- port_num (integer) – PoE Channel Index.
- port_name (string) – The name of the resource (IE a PoE Channel can be named and are tagged with this name should an alert occur from this resource).
- pcycl_dur (integer) – number of seconds to pulse the PoE Channel Output, should a pulse command be executed. (<0 pulse off, >0 pulse on)
-
POST
/ATX/hardware/chs/
(string: index)/data
¶ Toggle the state of the PoE Channel
Example request:
POST /ATX/hardware/chs/ch2/data HTTP/1.0 Host: 192.168.168.168 Accept: application/json, text/javascript Content-Type: application/json { "port_en":"t" }
Request JSON Object: - port_en (string) – If the supplied property is a string “t” , the PoE Channel will toggle between the “on/off” states.
Example response:
HTTP/1.0 200 OK Content-Type: application/json { "_sig": "", "error": 0 }
-
POST
/ATX/hardware/chs/mask
¶ Pulse PoE Channel Power Output.
Example request:
POST /ATX/hardware/chs/mask HTTP/1.0 Host: 192.168.168.168 Accept: application/json, text/javascript Content-Type: application/json { "mask":"xpxx" }
Request JSON Object: - mask (string) – This property follows the pattern “aaaa” with characters from left to right meaning ch1 to ch4. An ‘a’ = “p” indicates to pulse that specific channel and ‘a’=”x” indicates no action on the specific port. E.g to pulse PoE Channel 2 the corresponding string will be equal to “xpxx”.
Example response:
HTTP/1.0 200 OK Content-Type: application/json { "_sig": "", "error": 0 }