@robotbas/robotcloud-client 0.3.1 → 0.3.3

package/types/request-params.d.ts

@@ -1,102 +1,106 @@
-/**
- *
- */
-
-import { MeasurementStatus } from "./services";
-
-/*
- *  GENERIC REQUEST PARAMS INTERFACES
- */
-
-export interface SubsystemRequestParams {
-  subsystem_id?: string;
-}
-
-export interface PaginableRequestParams {
-  startIndex?: number;
-  maxSize?: number;
-}
-export interface SortableListRequestParams {
-  sort_by?: string; // Prefix the field name with '-' for descending order.
-}
-
-export interface SubsystemTagsRequestParams extends SubsystemRequestParams {
-  tag_id?: string | string[];
-}
-
-export interface BaseFullPaginableRequestParams
-  extends SubsystemTagsRequestParams,
-  PaginableRequestParams { }
-
-/*
- * CONCRETE INTERFACES
- */
-
-export interface ProjectClassifiersRequestParams
-  extends PaginableRequestParams { }
-
-export interface ProjectsRequestParams extends PaginableRequestParams {
-  "organization-id": string;
-}
-
-export interface ProjectDetailsRequestParams { }
-
-export interface ProjectLocationsRequestParams
-  extends BaseFullPaginableRequestParams { }
-
-export interface ServiceInstanceDataRequestParams { }
-
-export interface ProjectTagRequestParams extends PaginableRequestParams {
-  parent_tag?: string;
-  no_parent?: boolean;
-}
-
-export interface LocationServiceInstancesRequestParams
-  extends BaseFullPaginableRequestParams { }
-
-export interface AlertLogsListRequestParams
-  extends BaseFullPaginableRequestParams,
-  SortableListRequestParams {
-  location_id?: string;
-  classifier_id?: string;
-  service_name?: string;
-  instance_id?: string;
-  name?: string;
-  active?: boolean;
-  acknowledged?: boolean;
-  ack_user?: string;
-  active_time?: string;
-  deactive_time?: string;
-  ack_time?: string;
-}
-export interface AlertsProjectStatsRequestParams extends SubsystemRequestParams { }
-export interface AlertAggregatedLogsRequestParams extends SubsystemTagsRequestParams {
-  location_id?: string;
-  classifier_id?: string;
-  service_name?: string;
-  instance_id?: string;
-  name?: string;
-  periode: `${number}${'h' | 'd' | 'w' | 'm' | 'y'}`;
-  offset?: string;
-  time_range: string;
-}
-export interface ServiceInstancesRequestParams
-  extends BaseFullPaginableRequestParams {
-  id?: string;
-  name?: string;
-  location_id?: string;
-  device_id?: string;
-}
-
-export interface ServiceDataRequestParams extends SubsystemTagsRequestParams { }
-
-export interface ServiceInstanceHistoricAggregateParams {
-  offset?: string;
-  property?: any[];
-  maxSize?: number;
-}
-export interface ServiceInstanceHistoricParams {
-  status?: MeasurementStatus;
-  property?: any[];
-  maxSize?: number;
-}
+/**
+ *
+ */
+
+import { MeasurementStatus } from "./services";
+
+/*
+ *  GENERIC REQUEST PARAMS INTERFACES
+ */
+
+export interface SubsystemRequestParams {
+  subsystem_id?: string;
+}
+
+export interface PaginableRequestParams {
+  startIndex?: number;
+  maxSize?: number;
+}
+export interface SortableListRequestParams {
+  sort_by?: string; // Prefix the field name with '-' for descending order.
+}
+
+export interface SubsystemTagsRequestParams extends SubsystemRequestParams {
+  tag_id?: string | string[];
+}
+
+export interface BaseFullPaginableRequestParams
+  extends SubsystemTagsRequestParams,
+  PaginableRequestParams { }
+
+/*
+ * CONCRETE INTERFACES
+ */
+
+export interface ProjectClassifiersRequestParams
+  extends PaginableRequestParams { }
+
+export interface ProjectsRequestParams extends PaginableRequestParams {
+  "organization-id": string;
+}
+
+export interface ProjectDetailsRequestParams { }
+
+export interface ProjectLocationsRequestParams
+  extends BaseFullPaginableRequestParams { }
+
+export interface ServiceInstanceDataRequestParams { }
+
+export interface ServiceInstanceAlertRequestParams { }
+
+export interface ProjectTagRequestParams extends PaginableRequestParams {
+  parent_tag?: string;
+  no_parent?: boolean;
+}
+
+export interface LocationServiceInstancesRequestParams
+  extends BaseFullPaginableRequestParams { }
+
+export interface AlertLogsListRequestParams
+  extends BaseFullPaginableRequestParams,
+  SortableListRequestParams {
+  location_id?: string;
+  classifier_id?: string;
+  service_name?: string;
+  instance_id?: string;
+  name?: string;
+  active?: boolean;
+  acknowledged?: boolean;
+  ack_user?: string;
+  active_time?: string;
+  deactive_time?: string;
+  ack_time?: string;
+}
+export interface AlertsProjectStatsRequestParams extends SubsystemRequestParams { }
+export interface AlertAggregatedLogsRequestParams extends SubsystemTagsRequestParams {
+  location_id?: string;
+  classifier_id?: string;
+  service_name?: string;
+  instance_id?: string;
+  name?: string;
+  periode: `${number}${'h' | 'd' | 'w' | 'm' | 'y'}`;
+  offset?: string;
+  time_range: string;
+}
+export interface ServiceInstancesRequestParams
+  extends BaseFullPaginableRequestParams {
+  id?: string;
+  name?: string;
+  location_id?: string;
+  device_id?: string;
+}
+
+export interface ServiceDataRequestParams extends SubsystemTagsRequestParams { }
+
+export interface ServiceAlertRequestParams extends SubsystemTagsRequestParams { }
+
+export interface ServiceInstanceHistoricAggregateParams {
+  offset?: string;
+  property?: any[];
+  maxSize?: number;
+}
+export interface ServiceInstanceHistoricParams {
+  status?: MeasurementStatus;
+  property?: any[];
+  maxSize?: number;
+}

package/types/services-configuration.d.ts

@@ -1,5 +1,30 @@
 import { RegimState, TemperatureUnit } from "./RobotCloudClient";
 
+export interface AirHandlingUnitConfigurationParams {
+  air_quality_co2_set_point?: number,
+  cool_heat_order?: "COOL" | "HEAT" | "AUTO";
+  conf_on?: boolean,
+  humidity_set_point?: number,
+  impulsion_hysteresis?: number,
+  pressure_set_point?: number,
+  temperature_set_point?: number
+}
+
+export interface AirQualityConfigurationParams {
+  high_co2_limit?: number;
+}
+
+export interface ChillerHeatingPumpConfigurationParams {
+  conf_max_capacity: number,
+  conf_on: boolean,
+  conf_recovery_state: boolean,
+  conf_regim: "COOL" | "HEAT" | "AUTO" | "FROST",
+  cool_set_point: number,
+  frost_set_point: number,
+  heat_set_point: number,
+  recovery_set_point: number
+}
+
 export interface RoomClimeConfigurationParams {
   temperature_set_point?: number;
   humidity_set_point?: number;
@@ -34,9 +59,18 @@ export interface RoomGuestStatusConfigurationParams {
 
 
 export interface RoomGroupingConfigurationParams {
-  replica_1_active: boolean;
-  replica_2_active: boolean;
-  replica_3_active: boolean;
-  associate_clime: boolean;
-  associate_presence: boolean;
+  replica_1_active?: boolean;
+  replica_2_active?: boolean;
+  replica_3_active?: boolean;
+  associate_clime?: boolean;
+  associate_presence?: boolean;
+}
+
+export interface RoomConsumesConfigurationParams {
+  daily_energy_electric_limit: number;
+  daily_energy_thermal_limit: number;
+  daily_hot_water_limit: number;
+  daily_cold_water_limit: number;
+  co2_electric_coefficient: number;
+  co2_thermal_coefficient: number;
 }

package/types/services.d.ts

@@ -1,6 +1,6 @@
 import { AxiosResponse } from "axios";
 import { ServiceInstanceRead } from "./ServiceInstanceRead";
-import { ServiceDataRequestParams, ServiceInstanceDataRequestParams, ServiceInstanceHistoricAggregateParams, ServiceInstanceHistoricParams } from "./request-params";
+import { ServiceDataRequestParams, ServiceInstanceDataRequestParams, ServiceAlertRequestParams, ServiceInstanceAlertRequestParams, ServiceInstanceHistoricAggregateParams, ServiceInstanceHistoricParams } from "./request-params";
 
 
 export type MeasurementStatus =
@@ -12,6 +12,34 @@ export type MeasurementStatus =
 export interface ServiceDataMeasurement<T> extends ServiceInstanceRead<T> {
   status: MeasurementStatus;
 }
+export interface AirHandlingUnit1AlertEventValue {
+  alarm_1: boolean,
+  alarm_2: boolean,
+  alarm_3: boolean,
+  alarm_4: boolean,
+  alarm_general: boolean
+}
+
+export interface AirHandlingUnit1DataEventValue {
+  cool_heat_state?: "COOL" | "HEAT" | "AUTO",
+  cool_heat_valve_state?: number,
+  heat_valve_state?: number,
+  impulsion_fan_speed?: number,
+  impulsion_fan_state?: boolean,
+  impulsion_flow?: number,
+  impulsion_set_point?: number,
+  impulsion_temperature?: number,
+  on?: boolean,
+  outdoor_air_damper_state?: number,
+  return_ambient_air_quality?: number,
+  return_ambient_co2?: number,
+  return_ambient_enthalpy?: number,
+  return_ambient_humidity?: number,
+  return_ambient_temperature?: number,
+  return_fan_speed?: number,
+  return_fan_state?: boolean,
+  return_flow?: number
+}
 
 export interface AirQuality1DataEventValue {
   co2: number;
@@ -21,6 +49,39 @@ export interface AirQuality1AlertEventValue {
   high_co2: boolean;
 }
 
+export interface ChillerHeatingPump1DataEventValue {
+  COP?: number,
+  capacity?: number,
+  compressor_state?: number,
+  condenser_impulsion_temperature?: number,
+  condenser_return_temperature?: number,
+  expansion_valve_position?: number,
+  flow_state?: boolean,
+  impulsion_temperature?: number,
+  max_capacity?: number,
+  on?: boolean,
+  recovery_impulsion_temperature?: number,
+  recovery_return_temperature?: number,
+  recovery_state?: boolean,
+  regim?: "COOL" | "HEAT" | "AUTO" | "FROST",
+  remote_state?: boolean,
+  return_temperature?: number
+}
+
+export interface ChillerHeatingPump1AlertEventValue {
+  alarm_1?: boolean;
+  alarm_2?: boolean;
+  alarm_3?: boolean;
+  alarm_4?: boolean;
+  alarm_5?: boolean;
+  alarm_6?: boolean;
+  alarm_7?: boolean;
+  alarm_8?: boolean;
+  alarm_9?: boolean;
+  alarm_10?: boolean;
+  alarm_general?: boolean;
+}
+
 export interface RoomGuestStatus1AlertEventValue {
   door_open_overtime: boolean;
   window_open_overtime: boolean;
@@ -47,30 +108,53 @@ export type HistoricAggregateFunction =
   | "nmax"
   | "nmin";
 
-  
+
 export interface ServiceInstanceConfigClient<T> {
   get(project_id: string, instance_id: string): Promise<AxiosResponse<T>>;
   put(project_id: string, instance_id: string, configuration: T): Promise<AxiosResponse<T>>;
 }
 
-export interface ServiceTypeClient<T_ALERTS, T_DATA> {
-
-  get configuration(): ServiceInstanceConfigClient<any>;  
-  getAlerts(
-    prjId: string,
-    params?: ServiceDataRequestParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_ALERTS>[]>>;
+export interface ServiceInstanceDataClient<T> {
+
+  /**
+   * Get data for a given project and instance
+   * @param prjId - The project ID
+   * @param instanceId - The instance ID
+   * @param params - The request parameters
+   * @returns A promise that resolves to the data
+   */
+  get(prjId: string, instanceId: string, params?: ServiceInstanceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<T>>>;
+
+  /**
+   * Get all data for a given project and service
+   * @param prjId - The project ID
+   * @param params - The request parameters
+   * @returns A promise that resolves to the data
+   */
+  getAll(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<T>[]>>;
+}
 
-  getData(
-    prjId: string,
-    params?: ServiceDataRequestParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+export interface ServiceInstanceAlertClient<T> {
+
+  /**
+   * Get Alert for a given project and instance
+   * @param prjId - The project ID
+   * @param instanceId - The instance ID
+   * @param params - The request parameters
+   * @returns A promise that resolves to the data
+   */
+  get(prjId: string, instanceId: string, params?: ServiceInstanceAlertRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<T>>>;
+
+  /**
+   * Get all alerts for a given project and service
+   * @param prjId - The project ID
+   * @param params - The request parameters
+   * @returns A promise that resolves to the data
+   */
+  getAll(prjId: string, params?: ServiceAlertRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<T>[]>>;
+}
 
-  getInstanceData(
-    prjId: string,
-    instanceId: string,
-    params?: ServiceInstanceDataRequestParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>>>;
+export interface ServiceInstanceHistoricClient<T> {
 
   getInstanceHistoric(
     prjId: string,
@@ -78,7 +162,7 @@ export interface ServiceTypeClient<T_ALERTS, T_DATA> {
     startTime: Date,
     endTime: Date,
     params: ServiceInstanceHistoricParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+  ): Promise<AxiosResponse<ServiceDataMeasurement<T>[]>>;
 
   getInstanceHistoricAggregate(
     prjId: string,
@@ -88,5 +172,13 @@ export interface ServiceTypeClient<T_ALERTS, T_DATA> {
     aggFunction: HistoricAggregateFunction,
     periode: string,
     params: ServiceInstanceHistoricAggregateParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+  ): Promise<AxiosResponse<ServiceDataMeasurement<T>[]>>;
 }
+
+
+export interface ServiceTypeClient<T_DATA, T_ALERTS, T_CONFIG> {
+  get configuration(): ServiceInstanceConfigClient<T_CONFIG>;
+  get data(): ServiceInstanceDataClient<T_DATA>;
+  get alert(): ServiceInstanceAlertClient<T_ALERTS>;
+  get historic(): ServiceInstanceHistoricClient<T_DATA>;
+}