node-red-contrib-mobius-flow-base 3.0.0-rc.4 → 3.0.0-rc.6

package/README.md

@@ -1,19 +1,47 @@
 # node-red-contrib-mobius-flow-base
 
-Copyright 2016 [iaconnects](http://www.iaconnects.co.uk).
+Copyright 2023 [MobiusFlow](https://mobiusflow.com/).
 
-[Node-RED](http://nodered.org) nodes to interact with MOBiUSFlow.
-
-This module currently requires access to the iaconnects private NPM repository.
+[Node-RED](http://nodered.org) nodes to interact with MobiusFlow.
 
 ## Nodes
 
-### Service Config Node
-All nodes require a connection to a MOBiUS hub. The `mobius service` node takes a service ID as a property and creates a shared connection to the hub. All other nodes use this shared connection.
+### Connection Config Node
+All nodes require a connection to a MobiusFlow Engine. The `mobius connection` config nodes connectes to the MobiusFlow Engine API via http / https
 
 ### Set Resource Node
 Sets the value of, or clears, the specified priority of resource.
 
+### Set Multi-Resource Node
+Sets the value of multiple resources on a given object at once
+
+### Send BCMD Node
+Sends a MobiusFlow broadcast command
+
+### Send DCMD Node
+Send a MobiusFlow direct command to a specified MobiusFlow service
+
+### Get Multi-Resource Node
+Get multiple resource at once
+
+### Get Multi-Object Node
+Get mutliple objects at once
+
+### MobiusFlow Inject Node
+Subscribe to change of value on a defined set of objects. Change events injected in MobiusFlow format.
+
+### Filter Object By Rid Value Node
+Return a filtered list of objects based on a defined filtering function and resource.
+
+### Discover Node
+Discover live MobiusFlow: Hubs, Services, Profiles, Objects and Resources
+
+### Discover Object List
+Discover live objects from a pre-defined set of potentially wildcarded URIs
+
+### Change Admin Password
+Change the password of the administator account of the MobiusFlow Engine
+
 ### Get Resource Node
 Reads the current `pv` or present value of a resource.
 
@@ -27,4 +55,5 @@ Clears the specified priority of resource.
 Subscribe to change of value events for an object
 
 ### Resource COV Node
-Subscribe to change of value events for a resource
+Subscribe to change of value events for a resource
+

package/dist/engine-api-calls.d.ts

@@ -1,21 +1,52 @@
 import { AxiosInstance } from 'axios';
-export declare const discover: (apiClient: AxiosInstance, uri: string, callback: Function) => Promise<void>;
-export declare const writeResource: (apiClient: AxiosInstance, uri: string, value: number | string | boolean, priority: number, callback: Function) => Promise<void>;
-export declare const writeMultiResource: (apiClient: AxiosInstance, uri: string, updates: {
-    r: string;
-    p: number;
-    v: number | string | boolean;
-}[], callback: Function) => Promise<void>;
-export declare const clearResource: (apiClient: AxiosInstance, uri: string, priority: number, callback: Function) => Promise<void>;
-export declare const readResource: (apiClient: AxiosInstance, uri: string, callback: Function) => Promise<void>;
-export declare const readObject: (apiClient: AxiosInstance, uri: string, callback: Function) => Promise<void>;
-export declare const sendBroadcastCommand: (apiClient: AxiosInstance, cid: string, commandData: any) => Promise<void>;
-export declare const sendDirectCommand: (apiClient: AxiosInstance, uri: string, cid: string, commandData: any, timeout: number, callback: Function) => Promise<void>;
-export declare const getServiceConfig: (apiClient: AxiosInstance, uri: string, callback: Function) => Promise<void>;
-export declare const updateObject: (apiClient: AxiosInstance, uri: string, config: any, callback: Function) => Promise<void>;
-export declare const filterObjectsByRIDValue: (apiClient: AxiosInstance, uri: string, pids: string[], rid: string, limit: number, func: (v: string | number | boolean) => boolean, callback: Function) => Promise<any>;
-export declare const getHubId: (apiClient: AxiosInstance, callback: Function) => Promise<void>;
-export declare const getNodeConfig: (apiClient: AxiosInstance, uri: string, callback: Function) => Promise<void>;
-export declare const changeAdminPassword: (apiClient: AxiosInstance, password: string, callback: Function) => Promise<void>;
-export declare const getNodeConfigTree: (apiClient: AxiosInstance, hid: string, callback: Function) => Promise<void>;
-export declare const getProfileByPid: (apiClient: AxiosInstance, hid: string, pid: string, callback: Function) => Promise<void>;
+interface EngineApiCallsInterace {
+    setApiClient: (apiClient: AxiosInstance) => void;
+    discover: (uri: string, callback: Function) => void;
+    writeResource: (uri: string, value: number | string | boolean, priority: number, callback: Function) => void;
+    writeMultiResource: (uri: string, updates: {
+        r: string;
+        p: number;
+        v: number | string | boolean;
+    }[], callback: Function) => void;
+    clearResource: (uri: string, priority: number, callback: Function) => void;
+    readResource: (uri: string, callback: Function) => void;
+    readObject: (uri: string, callback: Function) => void;
+    sendBroadcastCommand: (cid: string, commandData: any) => void;
+    sendDirectCommand: (uri: string, cid: string, commandData: any, timeout: number, callback: Function) => void;
+    getServiceConfig: (uri: string, callback: Function) => void;
+    updateObject: (uri: string, config: any, callback: Function) => void;
+    filterObjectsByRIDValue: (uri: string, pids: string[], rid: string, limit: number, func: (v: string | number | boolean) => boolean, callback: Function) => void;
+    getHubId: (callback: Function) => void;
+    getNodeConfig: (uri: string, callback: Function) => void;
+    changeAdminPassword: (password: string, callback: Function) => void;
+    getNodeConfigTree: (hid: string, callback: Function) => void;
+    getProfileByPid: (hid: string, pid: string, callback: Function) => void;
+    getAllObjectProfiles: (hid: string, callback: Function) => void;
+}
+export declare class EngineApiCalls implements EngineApiCallsInterace {
+    private apiClient;
+    constructor();
+    setApiClient: (apiClient: AxiosInstance) => void;
+    discover: (uri: string, callback: Function) => Promise<void>;
+    writeResource: (uri: string, value: number | string | boolean, priority: number, callback: Function) => Promise<void>;
+    writeMultiResource: (uri: string, updates: {
+        r: string;
+        p: number;
+        v: number | string | boolean;
+    }[], callback: Function) => Promise<void>;
+    clearResource: (uri: string, priority: number, callback: Function) => Promise<void>;
+    readResource: (uri: string, callback: Function) => Promise<void>;
+    readObject: (uri: string, callback: Function) => Promise<void>;
+    sendBroadcastCommand: (cid: string, commandData: any) => Promise<void>;
+    sendDirectCommand: (uri: string, cid: string, commandData: any, timeout: number, callback: Function) => Promise<void>;
+    getServiceConfig: (uri: string, callback: Function) => Promise<void>;
+    updateObject: (uri: string, config: any, callback: Function) => Promise<void>;
+    filterObjectsByRIDValue: (uri: string, pids: string[], rid: string, limit: number, func: (v: string | number | boolean) => boolean, callback: Function) => Promise<any>;
+    getHubId: (callback: Function) => Promise<void>;
+    getNodeConfig: (uri: string, callback: Function) => Promise<void>;
+    changeAdminPassword: (password: string, callback: Function) => Promise<void>;
+    getNodeConfigTree: (hid: string, callback: Function) => Promise<void>;
+    getProfileByPid: (hid: string, pid: string, callback: Function) => Promise<void>;
+    getAllObjectProfiles: (hid: string, callback: Function) => Promise<void>;
+}
+export {};