45fd50265f
- Removed group and description attributes from ObjectDescriptor SKIPPED: psi/dornier2.c psi/libpsi.a psi/make_gen psi/makefile_linux psi/pimotor.c psi/pipiezo.c psi/psi.c psi/serial.c psi/sinqhttp.c psi/sinqhttp.h psi/tcpdornier.c psi/velodornier.c
57 lines
2.2 KiB
HTML
57 lines
2.2 KiB
HTML
<HTML>
|
|
<HEAD>
|
|
<TITLE>SICS Metadata</TITLE>
|
|
</HEAD>
|
|
<BODY>
|
|
<H1>SICS Metadata</H1>
|
|
<P>
|
|
This section describes the <b>list</b> command for retrieving and
|
|
setting information about a running SICS server and the objects living in it.
|
|
Each SICS object has metadata associated with it: some of it is generated by the system such
|
|
as the object type, the interface it implements etc. Some additional metadata can be set by the
|
|
user. Most commands print their data in the form of a Tcl-list. The list is terminated with the entry ENDLIST.
|
|
This entry can be searched for by clients interested to find the end of the transmission. The general form of the
|
|
metadata is a key value pair. The following commands are implemented:
|
|
<dl>
|
|
<dt>list
|
|
<dd>Prints a list of all SICS objects.
|
|
<dt>list server
|
|
<dd>Prints a list of all server options.
|
|
<dt>list sicsobject
|
|
<dd>Prints all the metadata associated with the SICS object sicsobject.
|
|
<dt>list sicsobject key
|
|
<dd>Prints the value of the key associated with the SICS object sicsobject.
|
|
<dt>list setatt sicsobject key value
|
|
<dd>Sets a user defined attribute with the name key and the value value for the SICS object sicsobject.
|
|
<dt>list metadatakey
|
|
<dd>List all unique entries for the specified metadata key. System supplied metadata keys are:
|
|
<dl>
|
|
<dt>type
|
|
<dd>The object class
|
|
<dt>interface
|
|
<dd>The object interfaces implemented by SICS
|
|
</dl>
|
|
This list may be augmented with user generated keys as defined through using the <b>list setatt obj key value</b> command.
|
|
An example:
|
|
<pre>
|
|
list type
|
|
</pre>
|
|
will print all the objects classes available in the SICS server.
|
|
<dt>list metadatakey value
|
|
<dd>List all the SICS objects which match the value for the metadatakey given as parameters. For example:
|
|
<pre>
|
|
list interface drivable
|
|
</pre>
|
|
will print all objects implementing the drivable interface in the SICS server.
|
|
<dt>list objstatus obj
|
|
<dd>Will query the current state of the SICS object obj. This makes sense for things like motors, counter etc. which
|
|
can be run asynchronously. The result can be idle, fault, busy etc.
|
|
<dt>list match mask
|
|
<dd>Will print the names of all SICS objects where the name
|
|
matches the wildcard given as mask.
|
|
|
|
</dl>
|
|
</P>
|
|
</BODY>
|
|
</HTML>
|