@zaber/motion 2.15.3 → 3.0.0

package/dist/lib/ascii/storage.js.map

@@ -1 +1 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../../src/ascii/storage.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAItD,oDAAsC;AAEtC;;GAEG;AACH,MAAa,WAAW;IAGtB,YAAY,IAAU;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW,EACX,KAAa,EACb,SAAkB,KAAK;QAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW,EACX,SAAkB,KAAK;QAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,oBAAoB,EACpB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW,EACX,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,6BAA6B,EAAE,CAAC;QAC5D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAClB,GAAW,EACX,KAAc;QAEd,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAC1D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAClB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,yBAAyB,EACzB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,sBAAsB,EACtB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CACnB,SAAiB,EAAE;QAEnB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAC/B,OAAO,QAAQ,CAAC,aAAa,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AAvMD,kCAuMC;AAED;;GAEG;AACH,MAAa,aAAa;IAGxB,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW,EACX,KAAa,EACb,SAAkB,KAAK;QAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW,EACX,SAAkB,KAAK;QAEvB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,oBAAoB,EACpB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW,EACX,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,6BAA6B,EAAE,CAAC;QAC5D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAClB,GAAW,EACX,KAAc;QAEd,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAC1D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAClB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,yBAAyB,EACzB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,sBAAsB,EACtB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CACnB,SAAiB,EAAE;QAEnB,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAC/B,OAAO,QAAQ,CAAC,aAAa,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AA9LD,sCA8LC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Axis } from './axis';\nimport { Device } from './device';\nimport * as gateway from '../gateway';\n\n/**\n * Class providing access to axis storage.\n */\nexport class AxisStorage {\n  private _axis: Axis;\n\n  constructor(axis: Axis) {\n    this._axis = axis;\n  }\n\n  /**\n   * Sets the axis value stored at the provided key.\n   * @param key Key to set the value at.\n   * @param value Value to set.\n   * @param encode Whether the stored value should be base64 encoded before being stored.\n   * This makes the string unreadable to humans using the ASCII protocol,\n   * however, values stored this way can be of any length and use non-ASCII and protocol reserved characters.\n   */\n  public async setString(\n    key: string,\n    value: string,\n    encode: boolean = false\n  ): Promise<void> {\n    const request = new gateway.DeviceSetStorageRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n    request.setValue(value);\n    request.setEncode(encode);\n\n    await gateway.callAsync('device/set_storage', request);\n  }\n\n  /**\n   * Gets the axis value stored with the provided key.\n   * @param key Key to read the value of.\n   * @param decode Whether the stored value should be decoded.\n   * Only use this when reading values set by storage.set with \"encode\" true.\n   * @return Stored value.\n   */\n  public async getString(\n    key: string,\n    decode: boolean = false\n  ): Promise<string> {\n    const request = new gateway.DeviceGetStorageRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n    request.setDecode(decode);\n\n    const response = await gateway.callAsync<gateway.StringResponse>(\n      'device/get_storage',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets the value at the provided key to the provided number.\n   * @param key Key to set the value at.\n   * @param value Value to set.\n   */\n  public async setNumber(\n    key: string,\n    value: number\n  ): Promise<void> {\n    const request = new gateway.DeviceSetStorageNumberRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n    request.setValue(value);\n\n    await gateway.callAsync('device/set_storage_number', request);\n  }\n\n  /**\n   * Gets the value at the provided key interpreted as a number.\n   * @param key Key to get the value at.\n   * @return Stored value.\n   */\n  public async getNumber(\n    key: string\n  ): Promise<number> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.DoubleResponse>(\n      'device/get_storage_number',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets the value at the provided key to the provided boolean.\n   * @param key Key to set the value at.\n   * @param value Value to set.\n   */\n  public async setBool(\n    key: string,\n    value: boolean\n  ): Promise<void> {\n    const request = new gateway.DeviceSetStorageBoolRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n    request.setValue(value);\n\n    await gateway.callAsync('device/set_storage_bool', request);\n  }\n\n  /**\n   * Gets the value at the provided key interpreted as a boolean.\n   * @param key Key to get the value at.\n   * @return Stored value.\n   */\n  public async getBool(\n    key: string\n  ): Promise<boolean> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/get_storage_bool',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Erases the axis value stored at the provided key.\n   * @param key Key to erase.\n   * @return A boolean indicating if the key existed.\n   */\n  public async eraseKey(\n    key: string\n  ): Promise<boolean> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/erase_storage',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Lists the axis storage keys matching a given prefix.\n   * Omit the prefix to list all the keys.\n   * @param prefix Optional key prefix.\n   * @return Storage keys matching the given prefix.\n   */\n  public async listKeys(\n    prefix: string = ''\n  ): Promise<string[]> {\n    const request = new gateway.DeviceStorageListKeysRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setPrefix(prefix);\n\n    const response = await gateway.callAsync<gateway.StringArrayResponse>(\n      'device/storage_list_keys',\n      request,\n      gateway.StringArrayResponse);\n    return response.getValuesList();\n  }\n\n  /**\n   * Determines whether a given key exists in axis storage.\n   * @param key Key which existence to determine.\n   * @return True indicating that the key exists, false otherwise.\n   */\n  public async keyExists(\n    key: string\n  ): Promise<boolean> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/storage_key_exists',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n}\n\n/**\n * Class providing access to device storage.\n */\nexport class DeviceStorage {\n  private _device: Device;\n\n  constructor(device: Device) {\n    this._device = device;\n  }\n\n  /**\n   * Sets the device value stored at the provided key.\n   * @param key Key to set the value at.\n   * @param value Value to set.\n   * @param encode Whether the stored value should be base64 encoded before being stored.\n   * This makes the string unreadable to humans using the ASCII protocol,\n   * however, values stored this way can be of any length and use non-ASCII and protocol reserved characters.\n   */\n  public async setString(\n    key: string,\n    value: string,\n    encode: boolean = false\n  ): Promise<void> {\n    const request = new gateway.DeviceSetStorageRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n    request.setValue(value);\n    request.setEncode(encode);\n\n    await gateway.callAsync('device/set_storage', request);\n  }\n\n  /**\n   * Gets the device value stored with the provided key.\n   * @param key Key to read the value of.\n   * @param decode Whether the stored value should be decoded.\n   * Only use this when reading values set by storage.set with \"encode\" true.\n   * @return Stored value.\n   */\n  public async getString(\n    key: string,\n    decode: boolean = false\n  ): Promise<string> {\n    const request = new gateway.DeviceGetStorageRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n    request.setDecode(decode);\n\n    const response = await gateway.callAsync<gateway.StringResponse>(\n      'device/get_storage',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets the value at the provided key to the provided number.\n   * @param key Key to set the value at.\n   * @param value Value to set.\n   */\n  public async setNumber(\n    key: string,\n    value: number\n  ): Promise<void> {\n    const request = new gateway.DeviceSetStorageNumberRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n    request.setValue(value);\n\n    await gateway.callAsync('device/set_storage_number', request);\n  }\n\n  /**\n   * Gets the value at the provided key interpreted as a number.\n   * @param key Key to get the value at.\n   * @return Stored value.\n   */\n  public async getNumber(\n    key: string\n  ): Promise<number> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.DoubleResponse>(\n      'device/get_storage_number',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets the value at the provided key to the provided boolean.\n   * @param key Key to set the value at.\n   * @param value Value to set.\n   */\n  public async setBool(\n    key: string,\n    value: boolean\n  ): Promise<void> {\n    const request = new gateway.DeviceSetStorageBoolRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n    request.setValue(value);\n\n    await gateway.callAsync('device/set_storage_bool', request);\n  }\n\n  /**\n   * Gets the value at the provided key interpreted as a boolean.\n   * @param key Key to get the value at.\n   * @return Stored value.\n   */\n  public async getBool(\n    key: string\n  ): Promise<boolean> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/get_storage_bool',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Erases the device value stored at the provided key.\n   * @param key Key to erase.\n   * @return A boolean indicating if the key existed.\n   */\n  public async eraseKey(\n    key: string\n  ): Promise<boolean> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/erase_storage',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Lists the device storage keys matching a given prefix.\n   * Omit the prefix to list all the keys.\n   * @param prefix Optional key prefix.\n   * @return Storage keys matching the given prefix.\n   */\n  public async listKeys(\n    prefix: string = ''\n  ): Promise<string[]> {\n    const request = new gateway.DeviceStorageListKeysRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setPrefix(prefix);\n\n    const response = await gateway.callAsync<gateway.StringArrayResponse>(\n      'device/storage_list_keys',\n      request,\n      gateway.StringArrayResponse);\n    return response.getValuesList();\n  }\n\n  /**\n   * Determines whether a given key exists in device storage.\n   * @param key Key which existence to determine.\n   * @return True indicating that the key exists, false otherwise.\n   */\n  public async keyExists(\n    key: string\n  ): Promise<boolean> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/storage_key_exists',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n}\n"]}
+{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../../src/ascii/storage.ts"],"names":[],"mappings":";AAAA,sDAAsD;AACtD,sDAAsD;;;;;;;;;;;;;;;;;;;;;;;;;;AAItD,oDAAsC;AAEtC;;;GAGG;AACH,MAAa,WAAW;IAGtB,YAAY,IAAU;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW,EACX,KAAa,EACb,UAAwC,EAAE;QAE1C,MAAM,EACJ,MAAM,GAAG,KAAK,GACf,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW,EACX,UAAwC,EAAE;QAE1C,MAAM,EACJ,MAAM,GAAG,KAAK,GACf,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,oBAAoB,EACpB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW,EACX,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,6BAA6B,EAAE,CAAC;QAC5D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAClB,GAAW,EACX,KAAc;QAEd,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAC1D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAClB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,yBAAyB,EACzB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,sBAAsB,EACtB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CACnB,UAAuC,EAAE;QAEzC,MAAM,EACJ,MAAM,GAAG,EAAE,GACZ,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAC/B,OAAO,QAAQ,CAAC,aAAa,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QACjE,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC;QACnD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QACvC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AAhND,kCAgNC;AAcD;;;GAGG;AACH,MAAa,aAAa;IAGxB,YAAY,MAAc;QACxB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW,EACX,KAAa,EACb,UAA0C,EAAE;QAE5C,MAAM,EACJ,MAAM,GAAG,KAAK,GACf,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QACxB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,OAAO,CAAC,SAAS,CAAC,oBAAoB,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW,EACX,UAA0C,EAAE;QAE5C,MAAM,EACJ,MAAM,GAAG,KAAK,GACf,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,uBAAuB,EAAE,CAAC;QACtD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,oBAAoB,EACpB,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW,EACX,KAAa;QAEb,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,6BAA6B,EAAE,CAAC;QAC5D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,2BAA2B,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAClB,GAAW,EACX,KAAc;QAEd,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,2BAA2B,EAAE,CAAC;QAC1D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACpB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;QAExB,MAAM,OAAO,CAAC,SAAS,CAAC,yBAAyB,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,OAAO,CAClB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,yBAAyB,EACzB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,QAAQ,CACnB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,sBAAsB,EACtB,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,CACnB,UAAyC,EAAE;QAE3C,MAAM,EACJ,MAAM,GAAG,EAAE,GACZ,GAAG,OAAO,CAAC;QACZ,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,4BAA4B,EAAE,CAAC;QAC3D,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;QAE1B,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,0BAA0B,EAC1B,OAAO,EACP,OAAO,CAAC,mBAAmB,CAAC,CAAC;QAC/B,OAAO,QAAQ,CAAC,aAAa,EAAE,CAAC;IAClC,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,SAAS,CACpB,GAAW;QAEX,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,oBAAoB,EAAE,CAAC;QACnD,OAAO,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QAC9C,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEpB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAC,SAAS,CACtC,2BAA2B,EAC3B,OAAO,EACP,OAAO,CAAC,YAAY,CAAC,CAAC;QACxB,OAAO,QAAQ,CAAC,QAAQ,EAAE,CAAC;IAC7B,CAAC;CACF;AAvMD,sCAuMC","sourcesContent":["// ==== THIS FILE IS GENERATED FROM A TEMPLATE ==== //\n// ============= DO NOT EDIT DIRECTLY ============= //\n\nimport { Axis } from './axis';\nimport { Device } from './device';\nimport * as gateway from '../gateway';\n\n/**\n * Class providing access to axis storage.\n * Requires at least Firmware 7.30.\n */\nexport class AxisStorage {\n  private _axis: Axis;\n\n  constructor(axis: Axis) {\n    this._axis = axis;\n  }\n\n  /**\n   * Sets the axis value stored at the provided key.\n   * @param key Key to set the value at.\n   * @param value Value to set.\n   * @param [options.encode=false] Whether the stored value should be base64 encoded before being stored.\n   * This makes the string unreadable to humans using the ASCII protocol,\n   * however, values stored this way can be of any length and use non-ASCII and protocol reserved characters.\n   */\n  public async setString(\n    key: string,\n    value: string,\n    options: AxisStorage.SetStringOptions = {}\n  ): Promise<void> {\n    const {\n      encode = false,\n    } = options;\n    const request = new gateway.DeviceSetStorageRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n    request.setValue(value);\n    request.setEncode(encode);\n\n    await gateway.callAsync('device/set_storage', request);\n  }\n\n  /**\n   * Gets the axis value stored with the provided key.\n   * @param key Key to read the value of.\n   * @param [options.decode=false] Whether the stored value should be decoded.\n   * Only use this when reading values set by storage.set with \"encode\" true.\n   * @returns Stored value.\n   */\n  public async getString(\n    key: string,\n    options: AxisStorage.GetStringOptions = {}\n  ): Promise<string> {\n    const {\n      decode = false,\n    } = options;\n    const request = new gateway.DeviceGetStorageRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n    request.setDecode(decode);\n\n    const response = await gateway.callAsync<gateway.StringResponse>(\n      'device/get_storage',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets the value at the provided key to the provided number.\n   * @param key Key to set the value at.\n   * @param value Value to set.\n   */\n  public async setNumber(\n    key: string,\n    value: number\n  ): Promise<void> {\n    const request = new gateway.DeviceSetStorageNumberRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n    request.setValue(value);\n\n    await gateway.callAsync('device/set_storage_number', request);\n  }\n\n  /**\n   * Gets the value at the provided key interpreted as a number.\n   * @param key Key to get the value at.\n   * @returns Stored value.\n   */\n  public async getNumber(\n    key: string\n  ): Promise<number> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.DoubleResponse>(\n      'device/get_storage_number',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets the value at the provided key to the provided boolean.\n   * @param key Key to set the value at.\n   * @param value Value to set.\n   */\n  public async setBool(\n    key: string,\n    value: boolean\n  ): Promise<void> {\n    const request = new gateway.DeviceSetStorageBoolRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n    request.setValue(value);\n\n    await gateway.callAsync('device/set_storage_bool', request);\n  }\n\n  /**\n   * Gets the value at the provided key interpreted as a boolean.\n   * @param key Key to get the value at.\n   * @returns Stored value.\n   */\n  public async getBool(\n    key: string\n  ): Promise<boolean> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/get_storage_bool',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Erases the axis value stored at the provided key.\n   * @param key Key to erase.\n   * @returns A boolean indicating if the key existed.\n   */\n  public async eraseKey(\n    key: string\n  ): Promise<boolean> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/erase_storage',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Lists the axis storage keys matching a given prefix.\n   * Omit the prefix to list all the keys.\n   * @param [options.prefix=''] Optional key prefix.\n   * @returns Storage keys matching the given prefix.\n   */\n  public async listKeys(\n    options: AxisStorage.ListKeysOptions = {}\n  ): Promise<string[]> {\n    const {\n      prefix = '',\n    } = options;\n    const request = new gateway.DeviceStorageListKeysRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setPrefix(prefix);\n\n    const response = await gateway.callAsync<gateway.StringArrayResponse>(\n      'device/storage_list_keys',\n      request,\n      gateway.StringArrayResponse);\n    return response.getValuesList();\n  }\n\n  /**\n   * Determines whether a given key exists in axis storage.\n   * @param key Key which existence to determine.\n   * @returns True indicating that the key exists, false otherwise.\n   */\n  public async keyExists(\n    key: string\n  ): Promise<boolean> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._axis.device.connection.interfaceId);\n    request.setDevice(this._axis.device.deviceAddress);\n    request.setAxis(this._axis.axisNumber);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/storage_key_exists',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n}\n\nnamespace AxisStorage {\n  export interface SetStringOptions {\n      encode?: boolean;\n  }\n  export interface GetStringOptions {\n      decode?: boolean;\n  }\n  export interface ListKeysOptions {\n      prefix?: string;\n  }\n}\n\n/**\n * Class providing access to device storage.\n * Requires at least Firmware 7.30.\n */\nexport class DeviceStorage {\n  private _device: Device;\n\n  constructor(device: Device) {\n    this._device = device;\n  }\n\n  /**\n   * Sets the device value stored at the provided key.\n   * @param key Key to set the value at.\n   * @param value Value to set.\n   * @param [options.encode=false] Whether the stored value should be base64 encoded before being stored.\n   * This makes the string unreadable to humans using the ASCII protocol,\n   * however, values stored this way can be of any length and use non-ASCII and protocol reserved characters.\n   */\n  public async setString(\n    key: string,\n    value: string,\n    options: DeviceStorage.SetStringOptions = {}\n  ): Promise<void> {\n    const {\n      encode = false,\n    } = options;\n    const request = new gateway.DeviceSetStorageRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n    request.setValue(value);\n    request.setEncode(encode);\n\n    await gateway.callAsync('device/set_storage', request);\n  }\n\n  /**\n   * Gets the device value stored with the provided key.\n   * @param key Key to read the value of.\n   * @param [options.decode=false] Whether the stored value should be decoded.\n   * Only use this when reading values set by storage.set with \"encode\" true.\n   * @returns Stored value.\n   */\n  public async getString(\n    key: string,\n    options: DeviceStorage.GetStringOptions = {}\n  ): Promise<string> {\n    const {\n      decode = false,\n    } = options;\n    const request = new gateway.DeviceGetStorageRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n    request.setDecode(decode);\n\n    const response = await gateway.callAsync<gateway.StringResponse>(\n      'device/get_storage',\n      request,\n      gateway.StringResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets the value at the provided key to the provided number.\n   * @param key Key to set the value at.\n   * @param value Value to set.\n   */\n  public async setNumber(\n    key: string,\n    value: number\n  ): Promise<void> {\n    const request = new gateway.DeviceSetStorageNumberRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n    request.setValue(value);\n\n    await gateway.callAsync('device/set_storage_number', request);\n  }\n\n  /**\n   * Gets the value at the provided key interpreted as a number.\n   * @param key Key to get the value at.\n   * @returns Stored value.\n   */\n  public async getNumber(\n    key: string\n  ): Promise<number> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.DoubleResponse>(\n      'device/get_storage_number',\n      request,\n      gateway.DoubleResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Sets the value at the provided key to the provided boolean.\n   * @param key Key to set the value at.\n   * @param value Value to set.\n   */\n  public async setBool(\n    key: string,\n    value: boolean\n  ): Promise<void> {\n    const request = new gateway.DeviceSetStorageBoolRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n    request.setValue(value);\n\n    await gateway.callAsync('device/set_storage_bool', request);\n  }\n\n  /**\n   * Gets the value at the provided key interpreted as a boolean.\n   * @param key Key to get the value at.\n   * @returns Stored value.\n   */\n  public async getBool(\n    key: string\n  ): Promise<boolean> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/get_storage_bool',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Erases the device value stored at the provided key.\n   * @param key Key to erase.\n   * @returns A boolean indicating if the key existed.\n   */\n  public async eraseKey(\n    key: string\n  ): Promise<boolean> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/erase_storage',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n\n  /**\n   * Lists the device storage keys matching a given prefix.\n   * Omit the prefix to list all the keys.\n   * @param [options.prefix=''] Optional key prefix.\n   * @returns Storage keys matching the given prefix.\n   */\n  public async listKeys(\n    options: DeviceStorage.ListKeysOptions = {}\n  ): Promise<string[]> {\n    const {\n      prefix = '',\n    } = options;\n    const request = new gateway.DeviceStorageListKeysRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setPrefix(prefix);\n\n    const response = await gateway.callAsync<gateway.StringArrayResponse>(\n      'device/storage_list_keys',\n      request,\n      gateway.StringArrayResponse);\n    return response.getValuesList();\n  }\n\n  /**\n   * Determines whether a given key exists in device storage.\n   * @param key Key which existence to determine.\n   * @returns True indicating that the key exists, false otherwise.\n   */\n  public async keyExists(\n    key: string\n  ): Promise<boolean> {\n    const request = new gateway.DeviceStorageRequest();\n    request.setInterfaceId(this._device.connection.interfaceId);\n    request.setDevice(this._device.deviceAddress);\n    request.setKey(key);\n\n    const response = await gateway.callAsync<gateway.BoolResponse>(\n      'device/storage_key_exists',\n      request,\n      gateway.BoolResponse);\n    return response.getValue();\n  }\n}\n\nnamespace DeviceStorage {\n  export interface SetStringOptions {\n      encode?: boolean;\n  }\n  export interface GetStringOptions {\n      decode?: boolean;\n  }\n  export interface ListKeysOptions {\n      prefix?: string;\n  }\n}\n"]}

package/dist/lib/ascii/stream.d.ts

@@ -79,6 +79,7 @@ export declare class Stream {
     lineRelative(...endpoint: Measurement[]): Promise<void>;
     /**
      * Queue an absolute line movement in the stream, targeting a subset of the stream axes.
+     * Requires at least Firmware 7.11.
      * @param targetAxesIndices Indices of the axes in the stream the movement targets.
      * Refers to the axes provided during the stream setup or further execution.
      * Indices are zero-based.
@@ -87,6 +88,7 @@ export declare class Stream {
     lineAbsoluteOn(targetAxesIndices: number[], endpoint: Measurement[]): Promise<void>;
     /**
      * Queue a relative line movement in the stream, targeting a subset of the stream axes.
+     * Requires at least Firmware 7.11.
      * @param targetAxesIndices Indices of the axes in the stream the movement targets.
      * Refers to the axes provided during the stream setup or further execution.
      * Indices are zero-based.
@@ -116,6 +118,7 @@ export declare class Stream {
     /**
      * Queue an absolute arc movement in the stream.
      * The movement will only target the specified subset of axes in the stream.
+     * Requires at least Firmware 7.11.
      * @param targetAxesIndices Indices of the axes in the stream the movement targets.
      * Refers to the axes provided during the stream setup or further execution.
      * Indices are zero-based.
@@ -129,6 +132,7 @@ export declare class Stream {
     /**
      * Queue a relative arc movement in the stream.
      * The movement will only target the specified subset of axes in the stream.
+     * Requires at least Firmware 7.11.
      * @param targetAxesIndices Indices of the axes in the stream the movement targets.
      * Refers to the axes provided during the stream setup or further execution.
      * Indices are zero-based.
@@ -158,6 +162,7 @@ export declare class Stream {
     /**
      * Queue an absolute circle movement in the stream.
      * The movement will only target the specified subset of axes in the stream.
+     * Requires at least Firmware 7.11.
      * @param targetAxesIndices Indices of the axes in the stream the movement targets.
      * Refers to the axes provided during the stream setup or further execution.
      * Indices are zero-based.
@@ -169,6 +174,7 @@ export declare class Stream {
     /**
      * Queue a relative circle movement in the stream.
      * The movement will only target the specified subset of axes in the stream.
+     * Requires at least Firmware 7.11.
      * @param targetAxesIndices Indices of the axes in the stream the movement targets.
      * Refers to the axes provided during the stream setup or further execution.
      * Indices are zero-based.
@@ -225,14 +231,14 @@ export declare class Stream {
     /**
      * Wait a specified time.
      * @param time Amount of time to wait.
-     * @param unit Units of time.
+     * @param [unit=Units.NATIVE] Units of time.
      */
     wait(time: number, unit?: Time | Native): Promise<void>;
     /**
      * Waits until the live stream executes all queued actions.
-     * @param throwErrorOnFault Determines whether to throw error when fault is observed.
+     * @param [options.throwErrorOnFault=true] Determines whether to throw error when fault is observed.
      */
-    waitUntilIdle(throwErrorOnFault?: boolean): Promise<void>;
+    waitUntilIdle(options?: Stream.WaitUntilIdleOptions): Promise<void>;
     /**
      * Cork the front of the stream's action queue, blocking execution.
      * Execution resumes upon uncorking the queue, or when the number of queued actions reaches its limit.
@@ -247,54 +253,54 @@ export declare class Stream {
     uncork(): Promise<void>;
     /**
      * Returns a boolean value indicating whether the live stream is executing a queued action.
-     * @return True if the stream is executing a queued action.
+     * @returns True if the stream is executing a queued action.
      */
     isBusy(): Promise<boolean>;
     /**
      * Gets the maximum speed of the live stream.
      * Converts the units using the first axis of the stream.
-     * @param unit Units of velocity.
-     * @return The maximum speed of the stream.
+     * @param [unit=Units.NATIVE] Units of velocity.
+     * @returns The maximum speed of the stream.
      */
     getMaxSpeed(unit?: Velocity | AngularVelocity | Native): Promise<number>;
     /**
      * Sets the maximum speed of the live stream.
      * Converts the units using the first axis of the stream.
      * @param maxSpeed Maximum speed at which any stream action is executed.
-     * @param unit Units of velocity.
+     * @param [unit=Units.NATIVE] Units of velocity.
      */
     setMaxSpeed(maxSpeed: number, unit?: Velocity | AngularVelocity | Native): Promise<void>;
     /**
      * Gets the maximum tangential acceleration of the live stream.
      * Converts the units using the first axis of the stream.
-     * @param unit Units of acceleration.
-     * @return The maximum tangential acceleration of the live stream.
+     * @param [unit=Units.NATIVE] Units of acceleration.
+     * @returns The maximum tangential acceleration of the live stream.
      */
     getMaxTangentialAcceleration(unit?: Acceleration | AngularAcceleration | Native): Promise<number>;
     /**
      * Sets the maximum tangential acceleration of the live stream.
      * Converts the units using the first axis of the stream.
      * @param maxTangentialAcceleration Maximum tangential acceleration at which any stream action is executed.
-     * @param unit Units of acceleration.
+     * @param [unit=Units.NATIVE] Units of acceleration.
      */
     setMaxTangentialAcceleration(maxTangentialAcceleration: number, unit?: Acceleration | AngularAcceleration | Native): Promise<void>;
     /**
      * Gets the maximum centripetal acceleration of the live stream.
      * Converts the units using the first axis of the stream.
-     * @param unit Units of acceleration.
-     * @return The maximum centripetal acceleration of the live stream.
+     * @param [unit=Units.NATIVE] Units of acceleration.
+     * @returns The maximum centripetal acceleration of the live stream.
      */
     getMaxCentripetalAcceleration(unit?: Acceleration | AngularAcceleration | Native): Promise<number>;
     /**
      * Sets the maximum centripetal acceleration of the live stream.
      * Converts the units using the first axis of the stream.
      * @param maxCentripetalAcceleration Maximum centripetal acceleration at which any stream action is executed.
-     * @param unit Units of acceleration.
+     * @param [unit=Units.NATIVE] Units of acceleration.
      */
     setMaxCentripetalAcceleration(maxCentripetalAcceleration: number, unit?: Acceleration | AngularAcceleration | Native): Promise<void>;
     /**
      * Returns a string which represents the stream.
-     * @return String which represents the stream.
+     * @returns String which represents the stream.
      */
     toString(): string;
     /**
@@ -321,17 +327,23 @@ export declare class Stream {
      * Queries the stream status from the device
      * and returns boolean indicating whether the stream is disabled.
      * Useful to determine if streaming was interrupted by other movements.
-     * @return True if the stream is disabled.
+     * @returns True if the stream is disabled.
      */
     checkDisabled(): Promise<boolean>;
     /**
      * Gets the axes of the stream.
-     * @return An array of axis numbers of the axes the stream is set up to control.
+     * @returns An array of axis numbers of the axes the stream is set up to control.
      */
     private _retrieveAxes;
     /**
      * Get the mode of the stream.
-     * @return Mode of the stream.
+     * @returns Mode of the stream.
      */
     private _retrieveMode;
 }
+declare namespace Stream {
+    interface WaitUntilIdleOptions {
+        throwErrorOnFault?: boolean;
+    }
+}
+export {};

package/dist/lib/ascii/stream.js

@@ -174,6 +174,7 @@ class Stream {
     }
     /**
      * Queue an absolute line movement in the stream, targeting a subset of the stream axes.
+     * Requires at least Firmware 7.11.
      * @param targetAxesIndices Indices of the axes in the stream the movement targets.
      * Refers to the axes provided during the stream setup or further execution.
      * Indices are zero-based.
@@ -191,6 +192,7 @@ class Stream {
     }
     /**
      * Queue a relative line movement in the stream, targeting a subset of the stream axes.
+     * Requires at least Firmware 7.11.
      * @param targetAxesIndices Indices of the axes in the stream the movement targets.
      * Refers to the axes provided during the stream setup or further execution.
      * Indices are zero-based.
@@ -253,6 +255,7 @@ class Stream {
     /**
      * Queue an absolute arc movement in the stream.
      * The movement will only target the specified subset of axes in the stream.
+     * Requires at least Firmware 7.11.
      * @param targetAxesIndices Indices of the axes in the stream the movement targets.
      * Refers to the axes provided during the stream setup or further execution.
      * Indices are zero-based.
@@ -279,6 +282,7 @@ class Stream {
     /**
      * Queue a relative arc movement in the stream.
      * The movement will only target the specified subset of axes in the stream.
+     * Requires at least Firmware 7.11.
      * @param targetAxesIndices Indices of the axes in the stream the movement targets.
      * Refers to the axes provided during the stream setup or further execution.
      * Indices are zero-based.
@@ -341,6 +345,7 @@ class Stream {
     /**
      * Queue an absolute circle movement in the stream.
      * The movement will only target the specified subset of axes in the stream.
+     * Requires at least Firmware 7.11.
      * @param targetAxesIndices Indices of the axes in the stream the movement targets.
      * Refers to the axes provided during the stream setup or further execution.
      * Indices are zero-based.
@@ -363,6 +368,7 @@ class Stream {
     /**
      * Queue a relative circle movement in the stream.
      * The movement will only target the specified subset of axes in the stream.
+     * Requires at least Firmware 7.11.
      * @param targetAxesIndices Indices of the axes in the stream the movement targets.
      * Refers to the axes provided during the stream setup or further execution.
      * Indices are zero-based.
@@ -484,7 +490,7 @@ class Stream {
     /**
      * Wait a specified time.
      * @param time Amount of time to wait.
-     * @param unit Units of time.
+     * @param [unit=Units.NATIVE] Units of time.
      */
     async wait(time, unit = units_1.Units.NATIVE) {
         const request = new gateway.StreamWaitRequest();
@@ -497,9 +503,10 @@ class Stream {
     }
     /**
      * Waits until the live stream executes all queued actions.
-     * @param throwErrorOnFault Determines whether to throw error when fault is observed.
+     * @param [options.throwErrorOnFault=true] Determines whether to throw error when fault is observed.
      */
-    async waitUntilIdle(throwErrorOnFault = true) {
+    async waitUntilIdle(options = {}) {
+        const { throwErrorOnFault = true, } = options;
         const request = new gateway.StreamWaitUntilIdleRequest();
         request.setInterfaceId(this.device.connection.interfaceId);
         request.setDevice(this.device.deviceAddress);
@@ -533,7 +540,7 @@ class Stream {
     }
     /**
      * Returns a boolean value indicating whether the live stream is executing a queued action.
-     * @return True if the stream is executing a queued action.
+     * @returns True if the stream is executing a queued action.
      */
     async isBusy() {
         const request = new gateway.StreamEmptyRequest();
@@ -546,8 +553,8 @@ class Stream {
     /**
      * Gets the maximum speed of the live stream.
      * Converts the units using the first axis of the stream.
-     * @param unit Units of velocity.
-     * @return The maximum speed of the stream.
+     * @param [unit=Units.NATIVE] Units of velocity.
+     * @returns The maximum speed of the stream.
      */
     async getMaxSpeed(unit = units_1.Units.NATIVE) {
         const request = new gateway.StreamGetMaxSpeedRequest();
@@ -562,7 +569,7 @@ class Stream {
      * Sets the maximum speed of the live stream.
      * Converts the units using the first axis of the stream.
      * @param maxSpeed Maximum speed at which any stream action is executed.
-     * @param unit Units of velocity.
+     * @param [unit=Units.NATIVE] Units of velocity.
      */
     async setMaxSpeed(maxSpeed, unit = units_1.Units.NATIVE) {
         const request = new gateway.StreamSetMaxSpeedRequest();
@@ -576,8 +583,8 @@ class Stream {
     /**
      * Gets the maximum tangential acceleration of the live stream.
      * Converts the units using the first axis of the stream.
-     * @param unit Units of acceleration.
-     * @return The maximum tangential acceleration of the live stream.
+     * @param [unit=Units.NATIVE] Units of acceleration.
+     * @returns The maximum tangential acceleration of the live stream.
      */
     async getMaxTangentialAcceleration(unit = units_1.Units.NATIVE) {
         const request = new gateway.StreamGetMaxTangentialAccelerationRequest();
@@ -592,7 +599,7 @@ class Stream {
      * Sets the maximum tangential acceleration of the live stream.
      * Converts the units using the first axis of the stream.
      * @param maxTangentialAcceleration Maximum tangential acceleration at which any stream action is executed.
-     * @param unit Units of acceleration.
+     * @param [unit=Units.NATIVE] Units of acceleration.
      */
     async setMaxTangentialAcceleration(maxTangentialAcceleration, unit = units_1.Units.NATIVE) {
         const request = new gateway.StreamSetMaxTangentialAccelerationRequest();
@@ -606,8 +613,8 @@ class Stream {
     /**
      * Gets the maximum centripetal acceleration of the live stream.
      * Converts the units using the first axis of the stream.
-     * @param unit Units of acceleration.
-     * @return The maximum centripetal acceleration of the live stream.
+     * @param [unit=Units.NATIVE] Units of acceleration.
+     * @returns The maximum centripetal acceleration of the live stream.
      */
     async getMaxCentripetalAcceleration(unit = units_1.Units.NATIVE) {
         const request = new gateway.StreamGetMaxCentripetalAccelerationRequest();
@@ -622,7 +629,7 @@ class Stream {
      * Sets the maximum centripetal acceleration of the live stream.
      * Converts the units using the first axis of the stream.
      * @param maxCentripetalAcceleration Maximum centripetal acceleration at which any stream action is executed.
-     * @param unit Units of acceleration.
+     * @param [unit=Units.NATIVE] Units of acceleration.
      */
     async setMaxCentripetalAcceleration(maxCentripetalAcceleration, unit = units_1.Units.NATIVE) {
         const request = new gateway.StreamSetMaxCentripetalAccelerationRequest();
@@ -635,7 +642,7 @@ class Stream {
     }
     /**
      * Returns a string which represents the stream.
-     * @return String which represents the stream.
+     * @returns String which represents the stream.
      */
     toString() {
         const request = new gateway.StreamEmptyRequest();
@@ -689,7 +696,7 @@ class Stream {
      * Queries the stream status from the device
      * and returns boolean indicating whether the stream is disabled.
      * Useful to determine if streaming was interrupted by other movements.
-     * @return True if the stream is disabled.
+     * @returns True if the stream is disabled.
      */
     async checkDisabled() {
         const request = new gateway.StreamEmptyRequest();
@@ -701,7 +708,7 @@ class Stream {
     }
     /**
      * Gets the axes of the stream.
-     * @return An array of axis numbers of the axes the stream is set up to control.
+     * @returns An array of axis numbers of the axes the stream is set up to control.
      */
     _retrieveAxes() {
         const request = new gateway.StreamEmptyRequest();
@@ -713,7 +720,7 @@ class Stream {
     }
     /**
      * Get the mode of the stream.
-     * @return Mode of the stream.
+     * @returns Mode of the stream.
      */
     _retrieveMode() {
         const request = new gateway.StreamEmptyRequest();