... | ... | @@ -32,7 +32,7 @@ group parameters. Subscription class could be used as an observer, which notifie |
|
|
used as polling.</p>
|
|
|
</dd>
|
|
|
<dt><a href="#Subscribe">Subscribe</a></dt>
|
|
|
<dd><p>Subscribe class is used to receive continious parameter updates from motorcortex server.
|
|
|
<dd><p>Subscribe class is used to receive continuous parameter updates from motorcortex server.
|
|
|
Subscribe class simplifies creating and removing subscription groups.</p>
|
|
|
</dd>
|
|
|
</dl>
|
... | ... | @@ -1188,7 +1188,7 @@ data_sub.then(function (subscription) { |
|
|
<a name="Subscribe"></a>
|
|
|
|
|
|
## Subscribe
|
|
|
Subscribe class is used to receive continious parameter updates from motorcortex server.
|
|
|
Subscribe class is used to receive continuous parameter updates from motorcortex server.
|
|
|
Subscribe class simplifies creating and removing subscription groups.
|
|
|
|
|
|
**Kind**: global class
|
... | ... | @@ -1204,12 +1204,12 @@ Subscribe class simplifies creating and removing subscription groups. |
|
|
<a name="new_Subscribe_new"></a>
|
|
|
|
|
|
### new exports.Subscribe(request)
|
|
|
Create subscribe
|
|
|
Creates subscribe
|
|
|
|
|
|
|
|
|
| Param | Type |
|
|
|
| --- | --- |
|
|
|
| request | [<code>Request</code>](#Request) |
|
|
|
| Param | Type | Description |
|
|
|
| --- | --- | --- |
|
|
|
| request | [<code>Request</code>](#Request) | A reference to the request object. |
|
|
|
|
|
|
<a name="Subscribe+connectionState"></a>
|
|
|
|
... | ... | @@ -1261,16 +1261,16 @@ Closes connection to the server |
|
|
Create a subscription group for a list of the parameters.
|
|
|
|
|
|
**Kind**: instance method of [<code>Subscribe</code>](#Subscribe)
|
|
|
**Returns**: <code>Subscription.<GroupStatusMsg></code> - Returns a Subsciption handle. It acts as a Promise, it is resolved
|
|
|
when subscription is ready or failed. After subscription is ready the Subscription handle is used to retrieve
|
|
|
the latest data.
|
|
|
**Returns**: <code>Subscription.<GroupStatusMsg></code> - Returns a subscription handle, which acts as a JavaScript Promise,
|
|
|
it is resolved when subscription is ready or failed. After the subscription
|
|
|
is ready the handle is used to retrieve latest data.
|
|
|
**See**: Subscription, motorcortex.proto, GroupStatusMsg, StatusCode
|
|
|
|
|
|
| Param | Type | Description |
|
|
|
| --- | --- | --- |
|
|
|
| path_list | <code>Array.<string></code> | List of the parameters to subscribe to. |
|
|
|
| group_alias | <code>string</code> | Name of the group. |
|
|
|
| [frq_divider] | <code>number</code> | Frequency divider is downscaling factor of the group publish rate. Default value is 1, every cycle of the publisher. |
|
|
|
| [frq_divider] | <code>number</code> | Frequency divider is a downscaling factor of the group publish rate. Default value is 1, every cycle of the publisher. |
|
|
|
|
|
|
**Example**
|
|
|
```js
|
... | ... | |