The Signal Search Extended returns a list of IO signal resources with additional properties for the given search criteria

URL

/rw/iosystem/signals

Method

POST

URL Params

action=signal-searchex Required

start={start_value}

limit={limit_value} Optional

Data Params

name={signal_name} Optional

device={device_name} Optional

network={network_name} Optional

category={category_name} Optional

category-pon={categorypon_name} Optional

type=DO | DI | AO | AI | GI | GO Optional

invert=true | false Optional

blocked=true | false Optional

name2={signal_name} Optional

device2={device_name} Optional

network2={network_name} Optional

category2={category_name} Optional

category-pon2={categorypon_name} Optional

type2=DO | DI | AO | AI | GI | GO Optional

invert2=true | false Optional

blocked2=true | false Optional

Success Response

HTTP_OK(200)

see HTTP Status codes

Example Response

<?xml version="1.0" encoding="UTF-8"?>
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>io</title>
    <base href="http://localhost/rw/iosystem/"/>
</head>
<body>
    <div class="state">
    <a href="signals?action=signal-search" rel="self"/>
    <ul>
        <li class="ios-signal-li" title="Local/DRV_1/DRV1TESTE2">
            <a href="signals/Local/DRV_1/DRV1TESTE2" rel="self"/>
            <span class="name">DRV1TESTE2</span>
            <span class="type">DO</span>
            <span class="category">safety</span>
            <span class="lvalue">0</span>
            <span class="lstate">simulated</span>
            <span class="pvalue">0</span>
            <span class="quality">good</span>
            <span class="ltime-sec">0</span>
            <span class="ltime-microsec">0</span>
            <span class="ptime-sec">0</span>
            <span class="ptime-microsec">0</span>
            <span class="write-access-level">None</span>
        </li>
        <li class="ios-signal-li" title="Local/DRV_1/DRV1BRAKE">
            <a href="signals/Local/DRV_1/DRV1BRAKE" rel="self"/>
            <span class="name">DRV1BRAKE</span>
            <span class="type">DO</span>
            <span class="category">safety</span>
            <span class="lvalue">0</span>
            <span class="lstate">simulated</span>
            <span class="pvalue">0</span>
            <span class="quality">good</span>
            <span class="ltime-sec">0</span>
            <span class="ltime-microsec">0</span>
            <span class="ptime-sec">0</span>
            <span class="ptime-microsec">0</span>
            <span class="write-access-level">None</span>
        </li>
    </ul>
    </div>
    </body>
    </html>

Resources

name signal name
type signal type
category signal category
lvalue signal logical value
lstate signal logical state
pvalue signal physical value
quality signal physical state
ltime-sec logical time high
ltime-microsec logical time low
ptime-sec physical time high
ptime-microsec physical time low
write-access-level signal write access level
start element index
limit Number of elements to read.
invert Possible to combine two search criteria, where the signal is retrieved only if both are true. One of the criteria should have the invert set to TRUE, otherwise it is functionally identical to single search criteria.

Error Response

Bad Request(400)

See Robot controller return codes

Sample Call

curl --digest -u "Default User":robotics -d "category=safety&type=DO" -X POST "http://localhost/rw/iosystem/signals?action=signal-searchex"

Notes

Not supported in bootserver mode