}

3.5M Operations

The keys Command

The keys command returns saved keyword data from a specified actor.

Whenever the hub sees keyword data from any actor, it saves a copy. You can retrieve the information using the keys command. This is primarily useful when you are first connecting to the hub. You can get the current state of the various actors without querying the actors directly. Thus you are sure to get the information quickly, without tying up the actor and without fear that an actor is busy and cannot answer you. Of course once you know the current state of the system, the best way to keep up to date is to monitor messages directly from the actors.

Last updated 2006-09-19. Command by Craig Loomis. Manual by Russell Owen.

Contents

Commands

getFor=actor key1 key2...

Requests data from a particular actor. If you do not specify any keywords then you get everything. See Returned Data for an example.

Replies

Note: the sample commands below include the actor (keys) and the sample replies include the actor (keys.actor or keys) and the severity code.

Returned Data

Returned data comes from actor keys.actor with severity code i. For example in response to keys getFor=tcc TCCPos AxePos: 

        keys.tcc i TCCPos=NaN,NaN,NaN; AxePos=104.00,31.87,0.35
        keys :

unmatchedKeys="key1", "key2"...

Used to report requested keywords have not been seen from the actor in question. For example, in response to keys getFor=tcc foo AirTemp: 

        keys w unmatchedKeys="foo"
        keys.tcc i AirTemp=14.20
        keys :

keysTxt

Used to report general error messages and warnings. For example, in response to keys getFor=foo:

        keys f keysTxt="actor foo is not connected"