@robotbas/robotcloud-client 0.0.2

package/types/RobotCloudClient.d.ts

@@ -0,0 +1,179 @@
+
+export type TemperatureUnit = "CELSIUS" | "FAHRENHEIT"
+export type RegimState = "COLD"|"HEAT"|"AUTO"
+
+export type ProjectAccessLevel = "BLOCKED" | "RESTRICTED" | "BASIC" | "ADVANCED"
+export type AppAccessLevel = "BLOCKED" | "STANDARD" | "ADVANCED" | "ADMIN"
+
+export type RobotCloudServiceType = "RoomClime_1"|"RoomGuestStatus_1"|"AirQuality_1"
+
+// Desired fancoil speed (0 = Auto, 1..3 = Manual Speed)
+export type FancoilSpeedState = 0|1|2|3;
+
+export interface ProjectRequestParams {
+
+}
+
+export interface ProjectDetailsRequestParams {
+
+}
+export interface SubsystemRequestParams {
+  subsystem_id?: string;
+}
+
+export interface PaginableRequestParams {
+  startIndex?: number;
+  maxSize?: number;
+}
+
+export interface ProjectLocationsRequestParams extends SubsystemRequestParams, PaginableRequestParams {
+  tag_id?: string | string[];
+}
+
+
+export interface ServiceInstanceDataRequestParams {
+
+}
+
+export interface ProjectTagRequestParams extends PaginableRequestParams {
+  parent_tag?: string;
+  no_parent?: boolean;
+}
+
+export interface ServiceInstancesRequestParams extends SubsystemRequestParams, PaginableRequestParams {
+  id?: string;
+  name?: string;
+  location_id?: string;
+  device_id?: string;
+  tag_id?: string[];
+}
+
+export interface LocationServiceInstancesRequestParams extends SubsystemRequestParams, PaginableRequestParams {
+  tag_id?: string[];
+}
+
+export interface RoomClimeInstanceConfigParams {
+  temperature_set_point?: number;
+  humidity_set_point?: number;
+  regim?: RegimState;
+  eco_mode?: "STANDBY" | "ECO" | "VIP";
+  fancoil_speed?: 0 | 1 | 2 | 3;
+  on?: boolean;
+  high_temperature_level?: number;
+  low_temperature_level?: number;
+  high_humidity_level?: number;
+  fancoil_on_time_limit?: number;
+  temperature_units?: TemperatureUnit;
+}
+
+
+/** RESPONSE **/
+
+export interface RobotCloudNamedItem {
+  id: string;
+  name: string;
+}
+
+export interface RobotCloudProject {
+  id: string;
+  name: string;
+  organization: string;
+}
+
+/** USERS */
+export interface RobotCloudUserDetails {
+    username: string;
+    name: string;
+    last_name: string;
+    email: string;
+    org_id: string;
+    org_access: number;
+}
+
+
+export interface RobotCloudProjectDetails extends RobotCloudProject {
+  version: number;
+  description?: string;
+  country?: string;
+  timezone?: string;
+  image_url?: string;
+  longitude?: number;
+  latitude?: number;
+  application_enabled?: boolean;
+  access_level?: ProjectAccessLevel;
+  app_access_level?: AppAccessLevel;
+}
+
+export interface RobotCloudDeviceDetails extends RobotCloudNamedItem {
+  description?: string;
+  location: string;
+  address: {
+    domain: number;
+    zone: number;
+    id: number;
+  };
+  type: number;
+  configuration_type: string;
+  tags: string;
+}
+
+export interface RobotCloudServiceTypeDetails {
+    description: string;
+    name: RobotCloudServiceType
+}
+/** SERVICE EVENTS VALUES **/
+export interface RoomClime1AlertEventValue {
+  high_temperature: boolean;
+  low_temperature: boolean;
+  high_humidity: boolean;
+  fancoil_on_overtime: boolean;
+}
+export interface RoomClime1EventValue {
+  temperature: number;
+  humidity: number;
+  fancoil_speed: number;
+  fancoil_manual: boolean;
+  on: boolean;
+  temperature_set_point: number; 
+  humidity_set_point: number; 
+  regim: RegimState;
+  eco_mode: "STANDBY"|"ECO"|"VIP";
+}
+
+export interface RoomConsumes1AlertEventValue {
+  high_daily_energy_electric: boolean;
+  high_daily_energy_thermal: boolean;
+  high_daily_hot_water: boolean;
+  high_daily_cold_water: boolean;
+}
+
+export interface RoomGrouping1DataEventValue {
+  replica_1_active: boolean;
+  replica_2_active: boolean;
+  replica_3_active: boolean;
+}
+
+export interface RoomConsumes1DataEventValue {
+    energy_electric: number;
+    energy_thermal: number;
+    hot_water: number;
+    cold_water: number;
+    daily_energy_electric: number;
+    daily_energy_thermal: number;
+    daily_hot_water: number;
+    daily_cold_water: number;
+    daily_co2_footprint: number;
+    daily_tree_equivalent: number;
+}
+
+/** SERVICE INSTANCES DEVICE CONFIG */
+export interface ServiceInstanceDeviceConfig {
+  device: string;
+}
+
+export interface RoomGrouping1InstanceDeviceConfig {
+  Main: ServiceInstanceDeviceConfig;
+  Replica_1: ServiceInstanceDeviceConfig;
+  Replica_2: ServiceInstanceDeviceConfig;
+  Replica_3: ServiceInstanceDeviceConfig;
+}

package/types/ServiceInstance.d.ts

@@ -0,0 +1,12 @@
+import { RobotCloudNamedItem } from "./RobotCloudClient";
+
+export interface RobotCloudServiceInstance extends RobotCloudNamedItem {
+    service: string;
+}
+  
+export interface ServiceInstanceDetails extends RobotCloudServiceInstance {
+  description: string;
+  tags: string[];
+  subsystems: string[];
+  classifier: string;
+}

package/types/ServiceInstanceRead.d.ts

@@ -0,0 +1,5 @@
+export interface ServiceInstanceRead<T> {
+    instance: string;
+    time_mark: string;
+    value: T;
+}

package/types/Token.d.ts

@@ -0,0 +1,12 @@
+export interface CheckTokenResponse {
+    renewed: boolean;
+    invalid: boolean;
+    access: string;
+    renew: string;
+}
+
+export interface RobotCloudJWTPayload {
+    exp: number;
+    sub: string; // username
+    org: string; // organization
+}

package/types/helpers.d.ts

@@ -0,0 +1,5 @@
+import { ProjectAccessLevel } from "./RobotCloudClient";
+
+export interface RobotCloudPermissionsHelper {
+    checkProjectAccess(prjId: string, required_project_access: ProjectAccessLevel): Promise<boolean>;
+}

package/types/services.d.ts

@@ -0,0 +1,108 @@
+import { AxiosResponse } from "axios";
+import { ServiceInstanceRead } from "./ServiceInstanceRead";
+import { SubsystemRequestParams } from "./RobotCloudClient";
+
+export type MeasurementStatus =  "GOOD"|"NOT_MEASURED"|"INVALID_VALUE"|"DEVICE_ERROR";
+
+export interface ServiceDataMeasurement<T> extends ServiceInstanceRead<T> {
+    status: MeasurementStatus;
+}
+
+export interface ServiceDataRequestParams extends SubsystemRequestParams {
+    tag_id?: string | string[];
+}
+export interface ServiceInstanceHistoricAggregateParams {
+    offset?: string;
+    property?: any[];
+    maxSize?: number;
+} 
+export interface ServiceInstanceHistoricParams {
+    status?: MeasurementStatus;
+    property?: any[];
+    maxSize?: number;
+} 
+
+export interface AirQuality1DataEventValue {
+    co2: number;
+}
+
+export interface AirQuality1AlertEventValue {
+    high_co2: boolean;
+}
+
+
+export interface RoomGuestStatus1AlertEventValue {
+    door_open_overtime: boolean;
+    window_open_overtime: boolean;
+    medical_alarm: boolean;
+}
+
+export interface RoomGuestStatus1EventValue {
+    sold: boolean;
+    occupied: boolean;
+    do_not_disturb: boolean;
+    make_up_room: boolean;
+    tray_status: "IDLE"|'READY'|'FINISH';
+    remote_occupation: boolean;
+    door_open: boolean;
+    window_open: boolean;
+    medical_alarm: boolean; // TODO: ???
+}
+
+export interface RoomGuestStatusInstanceConfigParams {
+    sold?: boolean;
+    do_not_disturb?: boolean;
+    make_up_room?: boolean;
+    remote_occupation?: boolean;
+    door_open_time_limit?: number;
+    window_open_time_limit?: number;
+    medical_alarm?: boolean;
+}
+
+
+////
+// Generic interface  types
+////
+
+export type HistoricAggregateFunction = "count"|"increase"|"mean"|"first"|"last"|"max"|"min"|"amax"|"amin"|"pmax"|"pmin"|"nmax"|"nmin";
+
+export interface ServiceTypeClient<T_ALERTS, T_DATA, T_CONFIG> {
+    getAlerts(
+        prjId: string,
+        params?: ServiceDataRequestParams
+    ): Promise<AxiosResponse<ServiceDataMeasurement<T_ALERTS>[]>>;
+
+    getData (
+        prjId: string,
+        params?: ServiceDataRequestParams
+    ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+
+    getInstanceConfiguration (
+        prjId: string,
+        instanceId: string
+    ): Promise<AxiosResponse<T_CONFIG>>;
+
+    putInstanceConfiguration (
+        prjId: string,
+        instanceId: string,
+        data: T_CONFIG
+    ): Promise<AxiosResponse<T_CONFIG>>;
+
+    getInstanceHistoric (
+        prjId: string,
+        instanceId: string,
+        startTime: Date,
+        endTime: Date,
+        params: ServiceInstanceHistoricParams
+    ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+
+    getInstanceHistoricAggregate(
+        prjId: string,
+        instanceId: string,
+        startTime: Date,
+        endTime: Date,
+        aggFunction: HistoricAggregateFunction,
+        periode: string,
+        params: ServiceInstanceHistoricAggregateParams
+    ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+}