halton-iot-mcp
Version:
MCP Server for Halton IoT Data API
47 lines • 2.27 kB
TypeScript
/**
* Halton IoT API Client
* Handles HTTP communication with the Halton IoT Data API
*/
import type { AggregateSeriesRequest, AggregateSeriesMultipleRequest, LastEventValueMultipleRequest, RawEventsRequest, SearchSystemVariablesRequest, SearchSystemsResponseData, SystemVariablesMetadataResponse, AggregateSeriesResponse, AggregateSeriesMultipleResponse, LastEventValueResponse, LastEventValueMultipleResponse, RawEventsResponse, SystemVariableResponseGenericReturnBody } from "./types.js";
export declare class HaltonApiClient {
private apiToken;
constructor(apiToken: string);
private request;
/**
* Get basic information about all accessible systems
*/
getAllSystems(): Promise<Record<string, SearchSystemsResponseData>>;
/**
* Get basic information about specified systems
*/
getSystems(systems: string[]): Promise<Record<string, SearchSystemsResponseData>>;
/**
* Retrieve a list of variables for specified systems
*/
getSystemVariables(systems: string[]): Promise<Record<string, SystemVariablesMetadataResponse>>;
/**
* Search for variables with search words
*/
searchSystemVariables(request: SearchSystemVariablesRequest, includeLastEventValues?: boolean): Promise<SystemVariableResponseGenericReturnBody>;
/**
* Get aggregate series data for a single variable
*/
getAggregateSeries(variable: string, request: AggregateSeriesRequest): Promise<Record<string, AggregateSeriesResponse>>;
/**
* Get aggregate series data for multiple variables
*/
getAggregateSeriesMultiple(request: AggregateSeriesMultipleRequest): Promise<Record<string, AggregateSeriesMultipleResponse>>;
/**
* Get last event data for a single variable
*/
getLastEventValue(variable: string, systems: string[]): Promise<Record<string, LastEventValueResponse>>;
/**
* Get last event data for multiple variables
*/
getLastEventValueMultiple(request: LastEventValueMultipleRequest): Promise<Record<string, LastEventValueMultipleResponse>>;
/**
* Get raw events for a variable
*/
getRawEvents(variable: string, request: RawEventsRequest): Promise<Record<string, RawEventsResponse>>;
}
//# sourceMappingURL=api-client.d.ts.map