04.01.2015 Views

CR1000 Manual - Campbell Scientific

CR1000 Manual - Campbell Scientific

CR1000 Manual - Campbell Scientific

SHOW MORE
SHOW LESS

You also want an ePaper? Increase the reach of your titles

YUMPU automatically turns print PDFs into web optimized ePapers that Google loves.

Section 8. Operation<br />

Table 92. BrowseSymbols API Command Parameters<br />

uri<br />

format<br />

Optional. Specifies the URI (p. 470) for the data source. When<br />

querying a <strong>CR1000</strong>, uri source, tablename and fieldname are<br />

optional. If source is not specified, dl (<strong>CR1000</strong>) is assumed. A<br />

field name is always specified in association with a table name.<br />

If the field name is not specified, all fields are output. If<br />

fieldname refers to an array without a subscript, all fields<br />

associated with that array will be output. Table name is<br />

optional. If table name is not used, the entire URI syntax is not<br />

needed.<br />

Optional. Specifies the format of the response. The values<br />

html, json, and xml are valid. If this parameter is omitted, or if<br />

the value is html, empty, or invalid, the response is HTML.<br />

Examples:<br />

http://192.168.24.106/command=BrowseSymbols&uri=dl:public&forma<br />

t=html<br />

Response: symbols for all tables are returned as HTML*<br />

http://192.168.24.106/command=BrowseSymbols&uri=dl:MainData&for<br />

mat=html<br />

Response: symbols for all fields in a single table (MainData) are<br />

returned as HTML*<br />

http://192.168.24.106/command=BrowseSymbols&uri=dl:MainData.Con<br />

d41&format=html<br />

Response: symbols for a single field (Cond41) are returned as<br />

HTML*<br />

BrowseSymbols Response<br />

The BrowseSymbols format parameter determines the format of the response. If<br />

a format is not specified, the format defaults to HTML. For more detail<br />

concerning data response formats, see the Data File Formats section.<br />

The response consists of a set of child symbol descriptions. Each of these<br />

descriptions include the following fields:<br />

Table 93. BrowseSymbols API Command Response<br />

name<br />

uri<br />

type<br />

is_enabled<br />

Specifies the name of the symbol. This could be a data source<br />

name, a station name, a table name, or a column name.<br />

Specifies the uri of the child symbol.<br />

Specifies a code for the type of this symbol. The symbol types<br />

include the following:<br />

6 — Table<br />

7 — Array<br />

8 — Scalar<br />

Boolean value that is set to true if the symbol is enabled for<br />

scheduled collection. This applies mostly to LoggerNet data<br />

sources.<br />

376

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!