Robot Web Services
3HAC050973-001 Revision:M, Application Manual - Robot Web Services
Devices tree information

Returns devices tree information

URL

/rw/devices

Method

GET

URL Params

Lang={lang} Optional

See Common URL parameters

Data Params

None

Success Response

HTTP_OK(200)

see HTTP Status codes

Sample Call 1

curl --digest -u "Default User":robotics "http://localhost/rw/devices"

Example Response 1

<?xml version="1.0" encoding="UTF-8"?>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>devices</title>
<base href="http://localhost/rw/devices/"/>
</head>
<body>
<div class="state">
<a href="" rel="self"/>
<ul>
<li class="dev-id-li" title="HW_DEVICES">
<a href="HW_DEVICES" rel="self">
<span class="name">Hardware devices</span>
</li>
<li class="dev-id-li" title="SW_RESOURCES">
<a href="SW_RESOURCES" rel="self">
<span class="name">Software resources</span>
</li>
</ul>
</body>
</html>

Sample Call 2

curl --digest -u "Default User":robotics "http://localhost/rw/devices/hw_devices/CONTROLLER/COMPUTER_SYSTEM/SERIAL_PORTS/COM1_PORT"

Example Response 2

<?xml version="1.0" encoding="UTF-8"?>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>devices</title>
<base href="http://localhost/rw/devices/hw_devices/CONTROLLER/COMPUTER_SYSTEM/SERIAL_PORTS/COM1_PORT/"/>
</head>
<body>
<div class="state">
<a href="" rel="self"/>
<ul>
<li class="dev-propstr-li" title="PROPERTY_COM1_PORT_LOCATION">
<a href="PROPERTY_COM1_PORT_LOCATION" rel="self"/>
<span class="name">Location</span>
<span class="value">Adapter board (DSQC 1003)</span>
</li>
<li class="dev-propint-li" title="PROPERTY_COM1_PORT_BAUDRATE">
<a href="PROPERTY_COM1_PORT_BAUDRATE" rel="self"/>
<span class="name">Baudrate</span>
<span class="value">9600</span>
</li>
<li class="dev-propint-li" title="PROPERTY_COM1_PORT_DATA_BITS">
<a href="PROPERTY_COM1_PORT_DATA_BITS" rel="self"/>
<span class="name">Data bits</span>
<span class="value">8</span>
</li>
<li class="dev-propstr-li" title="PROPERTY_COM1_PORT_PARITY">
<a href="PROPERTY_COM1_PORT_PARITY" rel="self"/>
<span class="name">Parity</span>
<span class="value">none</span>
</li>
<li class="dev-propint-li" title="PROPERTY_COM1_PORT_STOP_BITS">
<a href="PROPERTY_COM1_PORT_STOP_BITS" rel="self"/>
<span class="name">Stop bits</span>
<span class="value">1</span>
</li>
<li class="dev-propstr-li" title="PROPERTY_COM1_PORT_FLOW_CONTROL">
<a href="PROPERTY_COM1_PORT_FLOW_CONTROL" rel="self"/>
<span class="name">Flow control</span>
<span class="value">none</span>
</li>
<li class="dev-propstr-li" title="PROPERTY_COM1_PORT_DUPLEX">
<a href="PROPERTY_COM1_PORT_DUPLEX" rel="self"/>
<span class="name">Duplex</span>
<span class="value">full</span>
</li>
</ul>
</div>
</body>
</html>

Resources

  • dev-id-li
    • name resource name
  • dev-propint-li
    • name resource name
    • value value is of type integer
    • unit resource unit if it exists
  • dev-propstr-li
    • name resource name
    • value value is of type string
    • unit resource unit if it exists
  • dev-proptid-li
    • name resource name
    • value value is of type textID, i.e. provides the status of resource. ex: OK, ENABLED etc

Error Response

BAD_REQUEST(400), NOT_FOUND(404)

HTTP Errors, see HTTP Status codes

See Robot controller return codes

Sample Call

curl --digest -u "Default User":robotics "http://localhost/rw/devices"

curl --digest -u "Default User":robotics "http://localhost/rw/devices/hw_devices/CONTROLLER/COMPUTER_SYSTEM/SERIAL_PORTS/COM1_PORT"

Notes

Not supported in bootserver mode.