100% open-source IoT Platform - Integrate your devices, add intelligence, build custom apps
Java asset-managementbuildingdashboarddataplatformdevice-managementedge-computingenergyenergy-managementenergy-monitorfleet-managementfleet-telematicsiotiot-applicationiot-platformmodbusmqttmqtt-brokerota-updaterules-enginesmartcity
Added asset-mixin for subscribing to attribute events for assets
Rich Turner70d00bc268df
diff --git a/ui/component/core/src/asset-mixin.ts b/ui/component/core/src/asset-mixin.tsnew file mode 100644index 000000000..48cda343b--- /dev/null+++ b/ui/component/core/src/asset-mixin.ts@@ -0,0 +1,113 @@+/* tslint:disable:no-empty */+import {EventProviderFactory, EventProviderStatus} from "./event";+import {arraysEqual} from "./util";+import {AttributeEvent} from "@openremote/model";++declare type Constructor<T = {}> = new (...args: any[]) => T;++export const subscribe = (eventProviderFactory: EventProviderFactory) => <T extends Constructor>(base: T) => {++ return class extends base {++ public _connectRequested = false;+ public _subscriptionId?: string;+ public _assetIds?: string[];+ public _statusCallback = (status: EventProviderStatus) => this._onEventProviderStatusChanged(status);++ public connectedCallback() {+ // @ts-ignore+ if (super.connectedCallback) {+ // @ts-ignore+ super.connectedCallback();+ }++ this.connect();+ }++ public disconnectedCallback() {+ this.disconnect();++ // @ts-ignore+ if (super.disconnectedCallback) {+ // @ts-ignore+ super.disconnectedCallback();+ }+ }++ public connect() {+ if (this._connectRequested || !eventProviderFactory.getEventProvider()) {+ return;+ }++ this._connectRequested = true;+ eventProviderFactory.getEventProvider()!.subscribeStatusChange(this._statusCallback);+ this._doConnect();+ }++ public async _doConnect() {+ if (!this._connectRequested || this._subscriptionId) {+ return;+ }++ if (!this._assetIds || this._assetIds.length === 0) {+ return;+ }++ if (eventProviderFactory.getEventProvider()!.status !== EventProviderStatus.CONNECTED) {+ return;+ }++ this._subscriptionId = await eventProviderFactory.getEventProvider()!.subscribeAttributeEvents(this._assetIds, (event) => this._onAttributeEvent(event));+ }++ public disconnect() {+ if (!this._connectRequested) {+ return;+ }+ this._connectRequested = false;+ eventProviderFactory.getEventProvider()!.unsubscribeStatusChange(this._statusCallback);+ this._doDisconnect();+ }++ public _doDisconnect() {+ if (!this._subscriptionId) {+ return;+ }++ eventProviderFactory.getEventProvider()!.unsubscribe(this._subscriptionId);+ this._subscriptionId = undefined;+ }++ public set assetIds(assetIds: string[]) {+ if (arraysEqual(this._assetIds, assetIds)) {+ return;+ }++ this._assetIds = assetIds;+ this._doDisconnect();+ this._doConnect();+ }++ public _onEventProviderStatusChanged(status: EventProviderStatus) {+ switch (status) {+ case EventProviderStatus.DISCONNECTED:+ this._doDisconnect();+ break;+ case EventProviderStatus.CONNECTED:+ this._doConnect();+ break;+ }+ }++ public _onAttributeEvent(event: AttributeEvent) {+ if (!this._connectRequested || !this._subscriptionId) {+ return;+ }++ this.onAttributeEvent(event);+ }++ // noinspection JSUnusedLocalSymbols+ public onAttributeEvent(event: AttributeEvent) {}+ };+};diff --git a/ui/component/core/src/event.ts b/ui/component/core/src/event.tsindex 5f5ffc007..a9c07750a 100644--- a/ui/component/core/src/event.ts+++ b/ui/component/core/src/event.ts@@ -1,5 +1,5 @@import openremote from "./index";-import {Deferred} from "./util";+import {arrayRemove, Deferred} from "./util";import {AttributeEvent,CancelEventSubscription,@@ -22,6 +22,10 @@ export interface EventProvider {disconnect(): void;+ subscribeStatusChange(callback: (status: EventProviderStatus) => void): void;++ unsubscribeStatusChange(callback: (status: EventProviderStatus) => void): void;+subscribe<T extends SharedEvent>(eventSubscription: EventSubscription<T>, callback: (event: T) => void): Promise<string>;unsubscribe<T extends SharedEvent>(subscriptionId: string): void;@@ -31,6 +35,11 @@ export interface EventProvider {sendEvent<T extends SharedEvent>(event: T): void;}+// Interface to provide a singleton implementation of EventProvider+export interface EventProviderFactory {+ getEventProvider(): EventProvider | undefined;+}+interface EventSubscriptionInfo<T extends SharedEvent> {eventSubscription: EventSubscription<T>;callback: (event: T) => void;@@ -51,10 +60,9 @@ abstract class EventProviderImpl implements EventProvider {protected _disconnectRequested: boolean = false;protected _reconnectDelayMillis: number = WebSocketEventProvider.MIN_RECONNECT_DELAY;protected _reconnectTimer: number | null = null;- protected _statusCallback: (status: EventProviderStatus) => void;protected _status: EventProviderStatus = EventProviderStatus.DISCONNECTED;protected _connectingDeferred: Deferred<boolean> | null = null;-+ protected _statusCallbacks: Array<(status: EventProviderStatus) => void> = [];protected _pendingSubscription: EventSubscriptionInfo<SharedEvent> | null = null;protected _queuedSubscriptions: EventSubscriptionInfo<SharedEvent>[] = [];protected _subscriptionMap: { [id: string]: EventSubscriptionInfo<SharedEvent> } = {};@@ -65,8 +73,12 @@ abstract class EventProviderImpl implements EventProvider {return this._status;}- protected constructor(statusCallback: (status: EventProviderStatus) => void) {- this._statusCallback = statusCallback;+ public subscribeStatusChange(callback: (status: EventProviderStatus) => void): void {+ this._statusCallbacks.push(callback);+ }++ public unsubscribeStatusChange(callback: (status: EventProviderStatus) => void): void {+ arrayRemove(this._statusCallbacks, callback);}public connect(): Promise<boolean> {@@ -219,7 +231,7 @@ abstract class EventProviderImpl implements EventProvider {this.sendEvent(readEvent);});} catch (e) {- console.log("Failed to subscribe to attribute events for assets: " + assetIds);+ console.error("Failed to subscribe to attribute events for assets: " + assetIds);if (subscriptionId) {this.unsubscribe(subscriptionId);}@@ -267,7 +279,7 @@ abstract class EventProviderImpl implements EventProvider {this._status = status;window.setTimeout(() => {- this._statusCallback(status);+ this._statusCallbacks.forEach((cb) => cb(status));}, 0);}@@ -362,8 +374,8 @@ export class WebSocketEventProvider extends EventProviderImpl {return this._endpointUrl;}- constructor(managerUrl: string, statusCallback: (connected: EventProviderStatus) => void) {- super(statusCallback);+ constructor(managerUrl: string) {+ super();this._endpointUrl = (managerUrl.startsWith("https:") ? "wss" : "ws") + "://" + managerUrl.substr(managerUrl.indexOf("://") + 3) + "/websocket/events";diff --git a/ui/component/core/src/index.ts b/ui/component/core/src/index.tsindex 67ab8a9bf..aa8959ef0 100644--- a/ui/component/core/src/index.ts+++ b/ui/component/core/src/index.ts@@ -3,7 +3,7 @@ import {Console} from "./console";import rest from "@openremote/rest";import {IconSets} from "@openremote/or-icon";import {AxiosRequestConfig} from "axios";-import {EventProvider, EventProviderStatus, WebSocketEventProvider} from "./event";+import {EventProvider, EventProviderFactory, EventProviderStatus, WebSocketEventProvider} from "./event";import i18next from "i18next";import i18nextXhr from "i18next-xhr-backend";import {AssetDescriptor, AttributeDescriptor, AttributeValueDescriptor, MetaItemDescriptor, Asset} from "@openremote/model/dist";@@ -152,7 +152,7 @@ export class AssetModelUtil {export type EventCallback = (event: OREvent) => any;-export class Manager {+export class Manager implements EventProviderFactory {get username() {return this._username;@@ -210,6 +210,10 @@ export class Manager {return i18next.language;}+ getEventProvider(): EventProvider | undefined {+ return this.events;+ }+protected static normaliseConfig(config: ManagerConfig): ManagerConfig {const normalisedConfig: ManagerConfig = Object.assign({}, config);@@ -280,7 +284,7 @@ export class Manager {private _managerVersion: string = "";private _listeners: EventCallback[] = [];private _console!: Console;- private _events: EventProvider | null = null;+ private _events?: EventProvider;public isManagerSameOrigin(): boolean {if (!this.initialised) {@@ -499,7 +503,8 @@ export class Manager {switch (this._config.eventProviderType) {case EventProviderType.WEBSOCKET:- this._events = new WebSocketEventProvider(this._config.managerUrl, (status: EventProviderStatus) => {this.onEventsProviderStatusChanged(status)});+ this._events = new WebSocketEventProvider(this._config.managerUrl);+ this._events.subscribeStatusChange((status: EventProviderStatus) => this._onEventProviderStatusChanged(status));connected = await this._events.connect();break;case EventProviderType.POLLING:@@ -513,7 +518,7 @@ export class Manager {return connected;}- protected onEventsProviderStatusChanged(status: EventProviderStatus) {+ protected _onEventProviderStatusChanged(status: EventProviderStatus) {switch (status) {case EventProviderStatus.DISCONNECTED:this._emitEvent(OREvent.EVENTS_DISCONNECTED);@@ -787,10 +792,10 @@ export class Manager {this.doEventsSubscriptionInit();}} else {- if (this._events != null) {+ if (this._events) {this._events.disconnect();}- this._events = null;+ this._events = undefined;}}}diff --git a/ui/component/core/src/util.ts b/ui/component/core/src/util.tsindex e61e5c8d2..4c84737b4 100644--- a/ui/component/core/src/util.ts+++ b/ui/component/core/src/util.ts@@ -41,7 +41,7 @@ export function getGeoNotificationsFromRulesSet(rulesetDefinition: JsonRulesetDegeoNotification = {} as GeoNotification;if (rule.when && rule.when.asset) {rule.when.asset.attributes!.predicates!.forEach((predicate) => {- if (predicate.value!.predicateType == "radial" || predicate.value!.predicateType == "rect") {+ if (predicate.value!.predicateType === "radial" || predicate.value!.predicateType === "rect") {geoNotification.predicate = predicate.value as RadialGeofencePredicate}});@@ -49,7 +49,7 @@ export function getGeoNotificationsFromRulesSet(rulesetDefinition: JsonRulesetDeif (rule.then) {rule.then.forEach((action) => {- if (action.action == "notification") {+ if (action.action === "notification") {if (action.notification && action.notification.message) {geoNotification.notification = action.notification.message as PushNotificationMessage;}@@ -63,3 +63,32 @@ export function getGeoNotificationsFromRulesSet(rulesetDefinition: JsonRulesetDereturn geoPredicates;}++export function arraysEqual<T>(arr1?: T[], arr2?: T[]) {+ if (arr1 === arr2) {+ return true;+ }+ if (!arr1 || !arr2) {+ return false;+ }+ if (arr1.length !== arr2.length) {+ return false;+ }+ for (let i = arr1.length; i--;) {+ if (arr1[i] !== arr2[i]) {+ return false;+ }+ }++ return true;+}++export function arrayRemove<T>(arr: T[], item: T) {+ if (arr.length === 0) {+ return;+ }+ const index = arr.indexOf(item);+ if (index >= 0) {+ arr.splice(index, 1);+ }+}diff --git a/ui/demo/demo-core/src/index.ts b/ui/demo/demo-core/src/index.tsindex 1e9df4158..efb4d7ad8 100644--- a/ui/demo/demo-core/src/index.ts+++ b/ui/demo/demo-core/src/index.ts@@ -1,7 +1,7 @@import {html, render} from "lit-html";import {when} from "lit-html/directives/when";-import openremote, {Auth, Manager, OREvent} from "@openremote/core";-import {AssetModelUtil} from "@openremote/core";+import openremote, {AssetModelUtil, Auth, Manager, OREvent} from "@openremote/core";+import {subscribe} from "@openremote/core/dist/asset-mixin";import "@openremote/or-icon";import "@openremote/or-translate";@@ -12,100 +12,103 @@ import i18next from "i18next";import {AttributeEvent, MetaItemType} from "@openremote/model";import {getApartment1Asset} from "./util";+class Demo {+ protected alarmEnabled = false;+ protected loggedInTemplate = (openremote: Manager) => html`<span>Welcome ${openremote.username} </span><button @click="${() =>+ openremote.logout()}">logout</button>`;+ protected loggedOutTemplate = (openremote: Manager) => html`<button @click="${() => openremote.login()}">login</button>`;+ protected mainTemplate = (openremote: Manager) => html`+ <p><b>Message:</b> ${when(openremote.authenticated, () => this.loggedInTemplate(openremote), () => this.loggedOutTemplate(openremote))}</p>+ <br/>+ <p><b>Initialised: </b> ${openremote.initialised}</p>+ <p><b>Manager Version: </b> ${openremote.managerVersion}</p>+ <p><b>Authenticated: </b> ${openremote.authenticated}</p>+ <p><b>Username: </b> ${openremote.username}</p>+ <p><b>Roles: </b> ${openremote.roles ? openremote.roles.join(", ") : ""}</p>+ <p><b>Is Super User: </b> ${openremote.isSuperUser()}</p>+ <p><b>Is Manager Same Origin: </b> ${openremote.isManagerSameOrigin()}</p>+ <p><b>Connection Status: </b> ${openremote.connectionStatus}</p>+ <p><b>Is Error: </b> ${openremote.isError}</p>+ <p><b>Error:</b> ${openremote.error}</p>+ <p><b>Config: </b> ${openremote.config ? JSON.stringify(openremote.config, null, 2) : ""}</p>+ <p><b>Console Registration: </b>${openremote.console ? JSON.stringify(openremote.console.registration, null, 2) : ""}</p>+ <p><b>Icon Example (Material Design icon set): </b><or-icon icon="access-point" /></p>+ <p><b>Icon Example (OR icon set): </b><or-icon icon="or:logo"></or-icon><or-icon icon="or:logo-plain"></or-icon><or-icon style="fill: #C4D600;" icon="or:marker"></or-icon></p>+ <p><b>Icon Example (dynamic Set click to add): </b><button @click="${() => this.createIconSet()}">Load</button>: <or-icon icon="test:x"></or-icon></p>+ <p><b>Translation Example: </b> <or-translate value="temperature"></or-translate> <button @click="${() => this.toggleLanguage()}">${i18next.language}</button></p>+ <p><b>Asset Descriptors: </b>${JSON.stringify(AssetModelUtil.getAssetDescriptors())}</p>+ <p><b>Attribute Descriptors: </b>${JSON.stringify(AssetModelUtil.getAttributeDescriptors())}</p>+ <p><b>Attribute Value Descriptors: </b>${JSON.stringify(AssetModelUtil.getAttributeValueDescriptors())}</p>+ <p><b>Meta Item Descriptors: </b>${JSON.stringify(AssetModelUtil.getMetaItemDescriptors())}</p>+ <p><b>Rule State Meta Item: </b>${JSON.stringify(AssetModelUtil.getMetaItemDescriptor(MetaItemType.RULE_STATE.urn))}</p>+ `;++ protected assetTemplate = (alarmEnabled: boolean) => html`<p><b>Alarm Enabled: </b> ${alarmEnabled}</p>`;++ protected _callback = (event: OREvent) => {+ console.log("OR Event:" + event);++ if (event === OREvent.READY) {+ if (openremote.authenticated) {+ this.initApartment1Asset().then(this.refreshUI);+ } else {+ this.refreshUI();+ }+ } else {+ this.refreshUI();+ }+ };-let alarmEnabled = false;--let loggedInTemplate = (openremote: Manager) => html`<span>Welcome ${openremote.username} </span><button @click="${() => {- openremote.logout()-}}">logout</button>`;--let loggedOutTemplate = (openremote: Manager) => html`<button @click="${() => {- openremote.login()-}}">login</button>`;--let mainTemplate = (openremote: Manager) => html`-<p><b>Message:</b> ${when(openremote.authenticated, () => loggedInTemplate(openremote), () => loggedOutTemplate(openremote))}</p>-<br/>-<p><b>Initialised: </b> ${openremote.initialised}</p>-<p><b>Manager Version: </b> ${openremote.managerVersion}</p>-<p><b>Authenticated: </b> ${openremote.authenticated}</p>-<p><b>Username: </b> ${openremote.username}</p>-<p><b>Roles: </b> ${openremote.roles ? openremote.roles.join(", ") : ""}</p>-<p><b>Is Super User: </b> ${openremote.isSuperUser()}</p>-<p><b>Is Manager Same Origin: </b> ${openremote.isManagerSameOrigin()}</p>-<p><b>Connection Status: </b> ${openremote.connectionStatus}</p>-<p><b>Is Error: </b> ${openremote.isError}</p>-<p><b>Error:</b> ${openremote.error}</p>-<p><b>Config: </b> ${openremote.config ? JSON.stringify(openremote.config, null, 2) : ""}</p>-<p><b>Console Registration: </b>${openremote.console ? JSON.stringify(openremote.console.registration, null, 2) : ""}</p>-<p><b>Icon Example (Material Design icon set): </b><or-icon icon="access-point" /></p>-<p><b>Icon Example (OR icon set): </b><or-icon icon="or:logo"></or-icon><or-icon icon="or:logo-plain"></or-icon><or-icon style="fill: #C4D600;" icon="or:marker"></or-icon></p>-<p><b>Icon Example (dynamic Set click to add): </b><button @click="${() => createIconSet()}">Load</button>: <or-icon icon="test:x"></or-icon></p>-<p><b>Translation Example: </b> <or-translate value="temperature"></or-translate> <button @click="${() => toggleLanguage()}">${i18next.language}</button></p>-<p><b>Asset Descriptors: </b>${JSON.stringify(AssetModelUtil.getAssetDescriptors())}</p>-<p><b>Attribute Descriptors: </b>${JSON.stringify(AssetModelUtil.getAttributeDescriptors())}</p>-<p><b>Attribute Value Descriptors: </b>${JSON.stringify(AssetModelUtil.getAttributeValueDescriptors())}</p>-<p><b>Meta Item Descriptors: </b>${JSON.stringify(AssetModelUtil.getMetaItemDescriptors())}</p>-<p><b>Rule State Meta Item </b>${JSON.stringify(AssetModelUtil.getMetaItemDescriptor(MetaItemType.RULE_STATE.urn))}</p>-`;--let assetTemplate = (alarmEnabled: boolean) => html `-<p><b>Alarm Enabled: </b> ${alarmEnabled}</p>-`;--async function refreshUI() {- render(mainTemplate(openremote), document.getElementById("info")!);- render(assetTemplate(alarmEnabled), document.getElementById("asset")!);-}+ constructor() {+ openremote.addListener(() => this._callback);+ if (openremote.authenticated) {+ this.initApartment1Asset().then(() => this.refreshUI());+ } else {+ this.refreshUI();+ }+ }-function createIconSet() {- let testIconSet = new IconSetSvg(100, {x: "<path d=\"M0,0 L100,100 M100,0 L0,100\" stroke=\"#000\"/>"});- IconSets.addIconSet("test", testIconSet);-}+ public async refreshUI() {+ render(this.mainTemplate(openremote), document.getElementById("info")!);+ render(this.assetTemplate(this.alarmEnabled), document.getElementById("asset")!);+ }-function toggleLanguage() {- i18next.changeLanguage(i18next.language === "en" ? "nl" : "en");-}+ public createIconSet() {+ let testIconSet = new IconSetSvg(100, {x: "<path d=\"M0,0 L100,100 M100,0 L0,100\" stroke=\"#000\"/>"});+ IconSets.addIconSet("test", testIconSet);+ }-async function subscribeApartmentAttributeEvents(assetId: string) {+ public toggleLanguage() {+ i18next.changeLanguage(i18next.language === "en" ? "nl" : "en");+ }- let callback: (event: AttributeEvent) => void = (event) => {- console.log("Event Received:" + JSON.stringify(event, null, 2));- if (event.attributeState && event.attributeState.attributeRef!.attributeName === "alarmEnabled") {- alarmEnabled = event.attributeState!.value;- refreshUI();- }- };+ public subscribeApartmentAttributeEvents(assetId: string) {};- let subscriptionId = await openremote.events!.subscribeAttributeEvents([assetId], callback);- console.log("Subscribed: " + subscriptionId);-}+ public async initApartment1Asset(): Promise<void> {-async function initApartment1Asset(): Promise<void> {-- const apartment1 = await getApartment1Asset();+ const apartment1 = await getApartment1Asset();- if (apartment1) {- console.log("Apartment 1 Asset received: " + JSON.stringify(apartment1, null, 2));- subscribeApartmentAttributeEvents(apartment1.id!);+ if (apartment1) {+ console.log("Apartment 1 Asset received: " + JSON.stringify(apartment1, null, 2));+ this.subscribeApartmentAttributeEvents(apartment1.id!);+ }}}-openremote.addListener((event: OREvent) => {- console.log("OR Event:" + event);+class DemoWithSubscribe extends subscribe(openremote)(Demo) {+ public subscribeApartmentAttributeEvents(assetId: string) {+ this.assetIds = [assetId];+ this.connect();+ }- switch(event) {- case OREvent.READY:- if (openremote.authenticated) {- initApartment1Asset().then(refreshUI);- } else {- refreshUI();- }- break;- default:- refreshUI();+ public onAttributeEvent(event: AttributeEvent) {+ console.log("Event Received:" + JSON.stringify(event, null, 2));+ if (event.attributeState && event.attributeState.attributeRef!.attributeName === "alarmEnabled") {+ this.alarmEnabled = event.attributeState!.value;+ this.refreshUI();+ }}-});+}openremote.init({managerUrl: "http://localhost:8080",@@ -116,5 +119,9 @@ openremote.init({configureTranslationsOptions: (options) => {options.lng = "nl"; // Change initial language to dutch}-})-;+}).then((success) => {+ if (success) {+ let ev = openremote.events;+ const demo = new DemoWithSubscribe();+ }+});