getINDI − get INDI property values
getINDI [options] [device.property.element ...]
getINDI connects to an indiserver and reports the current value of one or more properties. Each property is specified using three components in the form:
Any component may be an asterisk, “*”, to serve as a wild card that matches all names in that component of the specification. If no property is specified, then all properties match, i.e., it is as if the specification “*.*.*” were given.
The last component of the property specification is usually the element name, but may be a reserved name to indicate an attribute of the property as a whole. These reserved names are as follows:
report the label attribute
report the group attribute
report the state attribute
report the permission attribute
report the timeout attribute
report the timestamp attribute
print just the value if expectiong exactly one matching property
enable downloading BLOBs
use file descriptor f already open as a socket to the indiserver. This is useful for scripts to make a session connection one time then reuse it for each invocation. If the file descriptor seems to be being closed, check that the close-on-exec flag is off; for example in perl use something like:
connect to alternate host h; the default is localhost.
continue to monitor for subsequent changes to each specified property until timeout.
connect using alternate port p; the default is 7624.
suppress some error message.
wait no longer than t seconds of no activity to gather the values for all the specified properties; the default is 2 seconds. Specify 0 to wait forever.
generate additional information on stderr. This is cumulative in that specifying more -v options will generate more output.
Usually only readable properties are shown. If this flag is set, then all properties, including those that are write-only, are shown.
For properties that are not BLOBs, the output of getINDI is one line per property. Unless the -1 option is given, each line is of the form:
A property that is a BLOB is saved in a file name device.property.element.format. Z compression is handled automatically, other formats are left unchanged. Note that BLOBs are not read by default, only when the -B option is used.
The getINDI program exits with a status of 0 if it suceeded in finding the value for each specified property. It exits with 1 if there was at least one property for which no value was found within the given timeout period. It exits with 2 if there was some other error such as not being able to connect to the indiserver.
In a perl script, gather all properties for the default indiserver and save them in an associative array %props which can then be used to look up a property value by name:
%props = split (/[=0/, ’getINDI’);
Wait up to ten seconds to get the values of all properties from the Mount device on the given host and non-standard port:
getINDI -h indihost -p 7655 -t 10 "Mount.\*.\*"
Print just current value of the wind speed element from the weather device:
getINDI -1 Weather.Wind.Speed
This getINDI.md generated from the man documentation with the commands:
groff -mandoc -Thtml getINDI.man > getINDI.html pandoc -t markdown_github getINDI.html > getINDI.md
and then tweaked for presentation.