osh-js
Version:
OSH javascript Toolkit
250 lines (245 loc) • 14.3 kB
JavaScript
/***************************** BEGIN LICENSE BLOCK ***************************
The contents of this file are subject to the Mozilla Public License, v. 2.0.
If a copy of the MPL was not distributed with this file, You can obtain one
at http://mozilla.org/MPL/2.0/.
Software distributed under the License is distributed on an "AS IS" basis,
WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
for the specific language governing rights and limitations under the License.
Copyright (C) 2015-2022 Georobotix Inc. All Rights Reserved.
Author: Mathieu Dhainaut <mathieu.dhainaut@gmail.com>
******************************* END LICENSE BLOCK ***************************/
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
import SensorWebApi from "../SensorWebApi";
import CommandFilter from "../command/CommandFilter";
import Collection from "../Collection";
import API from "../routes.conf";
import ControlFilter from "./ControlFilter";
import ObservationsCollection from "../ObservationsCollection";
import SweApiFetchCommandParser from "../../parsers/sweapi/collection/SweApiFetchCommand.parser";
import SweApiResultCollectionControlParser from "../../parsers/sweapi/observations/SweApiResult.collection.control.parser";
import SweApiResultControlParser from "../../parsers/sweapi/observations/SweApiResult.control.parser";
import SweApiControlStatusParser from "../../parsers/sweapi/collection/SweApiControlStatus.parser";
var Control = /** @class */ (function (_super) {
__extends(Control, _super);
/**
* @param {Object} properties - the properties of the object
* @param {Object} [networkProperties={}]
* @param {String} networkProperties.endpointUrl - defines the Http(s) endpoint URL
* @param {Boolean} networkProperties.tls - defines is use Http or Https secure protocol for fetching data
* @param {String} [networkProperties.streamProtocol='ws'] - the Stream protocol to use: 'ws' pr 'mqtt'
* @param {Object} [networkProperties.mqttOpts={}] - the Mqtt options if stream protocol is 'mqtt'
* @param {String} networkProperties.mqttOpts.prefix - the Mqtt prefix value
* @param {String} networkProperties.mqttOpts.endpointUrl - the Mqtt specific endpointUrl
*/
function Control(properties, networkProperties) {
var _this = _super.call(this, networkProperties) || this;
_this.properties = properties;
_this.commandParser = new SweApiFetchCommandParser(networkProperties, _this.properties['system@id']);
_this.sweApiResultCollectionControlParser = new SweApiResultCollectionControlParser(_this);
_this.sweApiResultControlParser = new SweApiResultControlParser(_this);
_this.sweApiControlStatusParser = new SweApiControlStatusParser();
return _this;
}
/**
* Get the list of commands received by a particular control interface
* route: /systems/{sysid}/controls/{dsid}/commands
* @param {CommandFilter} [commandFilter=new CommandFilter()] - default Command filter
* @param {Number} [pageSize=10] - default page size
* @return {Promise<Collection<JSON>>} - result as JSON
*/
Control.prototype.searchCommands = function (commandFilter, pageSize) {
if (commandFilter === void 0) { commandFilter = new CommandFilter(); }
if (pageSize === void 0) { pageSize = 10; }
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, new ObservationsCollection(this.baseUrl() + API.controls.commands.replace('{sysid}', this.properties['system@id']).replace('{dsid}', this.properties.id), commandFilter, pageSize, this.sweApiResultCollectionControlParser)];
});
});
};
/**
* Stream all commands received by a particular control interface
* route: /systems/{sysid}/controls/{dsid}/commands
* @param {ControlFilter} [controlFilter= new ControlFilter()] - default Control filter
* @param {Function} callback - A callback to get observations
*/
Control.prototype.streamCommands = function (controlFilter, callback) {
var _this = this;
if (controlFilter === void 0) { controlFilter = new ControlFilter(); }
if (callback === void 0) { callback = function () { }; }
this.stream().onMessage = function (message) { return __awaiter(_this, void 0, void 0, function () {
var dataBlock;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.sweApiResultControlParser.parseDataBlock(message, controlFilter.props.format)];
case 1:
dataBlock = _a.sent();
callback(dataBlock);
return [2 /*return*/];
}
});
}); };
this.stream().doRequest(API.controls.commands.replace('{sysid}', this.properties['system@id']).replace('{dsid}', this.properties.id), controlFilter.toQueryString(), 'arraybuffer');
};
/**
* Get a specific command resource by ID.
* route: /systems/{sysid}/controls/{dsid}/commands/{cmdid}
* @param {String} commandId - the ID of the Command resource
* @param {CommandFilter} [commandFilter=new CommandFilter()] - default Command filter
* @returns {Promise<Command>} - The corresponding Command
*/
Control.prototype.getCommandById = function (commandId, commandFilter) {
if (commandFilter === void 0) { commandFilter = new CommandFilter(); }
return __awaiter(this, void 0, void 0, function () {
var apiUrl, queryString, jsonData;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
apiUrl = API.controls.command_by_id
.replace('{sysid}', this.properties['system@id'])
.replace('{dsid}', this.properties.id)
.replace('{cmdid}', commandId);
queryString = commandFilter.toQueryString(['select', 'obsFormat']);
return [4 /*yield*/, this.fetchAsJson(apiUrl, queryString)];
case 1:
jsonData = _a.sent();
return [2 /*return*/, this.commandParser.parseData(jsonData)];
}
});
});
};
/**
* Send a new command to this control interface
* route: /systems/{sysid}/controls/{dsid}/commands
* @param {JSON} jsonPayload - the JSON payload
* @param {CommandFilter} [commandFilter=new CommandFilter()] - default Command filter specifying the 'sysid' and 'dsid'
*/
Control.prototype.postCommand = function (jsonPayload, commandFilter) {
if (commandFilter === void 0) { commandFilter = new CommandFilter(); }
var apiUrl = API.controls.commands
.replace('{sysid}', this.properties['system@id'])
.replace('{dsid}', this.properties.id);
this.postAsJson(apiUrl, jsonPayload);
};
/**
* Send a new command to this control interface using streaming protocol such like WS or MQTT
* route: /systems/{sysid}/controls/{dsid}/commands
* @param {JSON} jsonPayload - the JSON payload
* @param {CommandFilter} [commandFilter=new CommandFilter()] - default Command filter specifying the 'sysid' and 'dsid'
*/
Control.prototype.publishCommand = function (payload, commandFilter) {
if (commandFilter === void 0) { commandFilter = new CommandFilter(); }
this.stream().publishRequest(API.controls.commands
.replace('{sysid}', this.properties['system@id'])
.replace('{dsid}', this.properties.id), payload);
};
/**
* Get all status messages sent by this control interface
* route: /systems/{sysid}/controls/{dsid}/status
* @param {ControlFilter} [controlFilter=new ControlFilter()] - default Control filter
* @param {Number} [pageSize=10] - default page size
* @return {Promise<Collection<JSON>>} - A Collection of JSON
*/
Control.prototype.searchStatus = function (controlFilter, pageSize) {
if (controlFilter === void 0) { controlFilter = new ControlFilter(); }
if (pageSize === void 0) { pageSize = 10; }
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, new Collection(this.baseUrl() + API.controls.status.replace('{sysid}', this.properties['system@id']).replace('{dsid}', this.properties.id), controlFilter, pageSize, this.sweApiControlStatusParser)];
});
});
};
/**
* Stream all status messages sent by this control interface
* route: /systems/{sysid}/controls/{dsid}/status
* @param {ControlFilter} [controlFilter= new ControlFilter()] - default Control filter
* @param {Function} callback - A callback to get observations
*/
Control.prototype.streamStatus = function (controlFilter, callback) {
var _this = this;
if (controlFilter === void 0) { controlFilter = new ControlFilter(); }
if (callback === void 0) { callback = function () { }; }
this.stream().onMessage = function (message) { return __awaiter(_this, void 0, void 0, function () {
var dataBlock;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.sweApiControlStatusParser.parseData(message, 'arraybuffer')];
case 1:
dataBlock = _a.sent();
callback(dataBlock);
return [2 /*return*/];
}
});
}); };
this.stream().doRequest(API.controls.status.replace('{sysid}', this.properties['system@id']).replace('{dsid}', this.properties.id), controlFilter.toQueryString(), 'arraybuffer');
};
/**
* Get the detailed schema of command messages in a command stream
* route: /systems/{sysid}/controls/{dsid}/schema
* @param {ControlFilter} [controlFilter= new ControlFilter()] - default Control filter, using 'commandFormat' to select response format
* @returns {Promise<JSON>} - The schema as JSON
*/
Control.prototype.getSchema = function (controlFilter) {
if (controlFilter === void 0) { controlFilter = new ControlFilter(); }
return __awaiter(this, void 0, void 0, function () {
var apiUrl, queryString;
return __generator(this, function (_a) {
apiUrl = API.controls.schema.replace('{sysid}', this.properties['system@id']).replace('{dsid}', this.properties.id);
queryString = controlFilter.toQueryString(['select', 'commandFormat']);
return [2 /*return*/, this.fetchAsJson(apiUrl, queryString)];
});
});
};
return Control;
}(SensorWebApi));
export default Control;
//# sourceMappingURL=Control.js.map