grenton-ts 1.0.0

package/dist/gate/output/v1/output.ts

@@ -0,0 +1,240 @@
+// Created from: packages/grenton-api/interfaces/object_output_v1.xml, object name="Output" version="1"
+
+import { rawExecutionBuilderFactory } from "../../../core/execution-builder"
+import { RemoteGate } from "../../../core/remote-gate"
+
+enum EventType {
+    OnChange = 0,
+    OnSwitchOn = 1,
+    OnSwitchOff = 2
+}
+
+enum PropertyType {
+    Value = 0,
+    Nr = 1,
+    UserPassword = 2
+}
+
+enum MethodType {
+    SwitchOn = 0,
+    SwitchOff = 1
+}
+
+enum ValueType {
+    Off = 0,
+    On = 1
+}
+
+declare class OutputRaw {
+    add_event(event: EventType, callback: () => void): void;
+    get(property: PropertyType): any;
+    set(property: PropertyType, value: any): void;
+    execute(method: MethodType, ...args: any[]): any;
+}
+
+interface IOutput {
+    /**
+     * Zdarzenie wywoływane przy zmianie stanu (niezależnie od wartości)
+     * @param callback
+     */
+    addOnChange: (callback: () => void) => void
+    /**
+     * Zdarzenie wywoływane przy ustawieniu On na wyjściu
+     * @param callback
+     */
+    addOnSwitchOn: (callback: () => void) => void
+    /**
+     * Zdarzenie wywoływane przy ustawieniu Off na wyjściu
+     * @param callback
+     */
+    addOnSwitchOff: (callback: () => void) => void
+    /** Załącza wyjście */
+    switchOn: () => void
+    /** Wyłącza wyjście */
+    switchOff: () => void
+    /** Zwraca stan wyjścia: 1 - wyjście załączone, 0 - wyjście wyłączone, -1 - stan wyjścia nieznany (brak połączenia z centralką) */
+    readonly value: ValueType
+    /** Parametr definiujący, do którego wyjścia odnosi się obiekt */
+    nr: number
+    /** Hasło użytkownika, dla _ zastosuje hasło administratora */
+    userPassword: string
+}
+
+class Output implements IOutput {
+    private onChangeCallbacks: Array<() => void> = [];
+    private onSwitchOnCallbacks: Array<() => void> = [];
+    private onSwitchOffCallbacks: Array<() => void> = [];
+
+    constructor(private raw: OutputRaw) {
+        this.raw.add_event(EventType.OnChange, () => {
+            this.onChangeCallbacks.forEach(callback => { callback(); });
+        });
+        this.raw.add_event(EventType.OnSwitchOn, () => {
+            this.onSwitchOnCallbacks.forEach(callback => { callback(); });
+        });
+        this.raw.add_event(EventType.OnSwitchOff, () => {
+            this.onSwitchOffCallbacks.forEach(callback => { callback(); });
+        });
+    }
+
+    /**
+     * Zdarzenie wywoływane przy zmianie stanu (niezależnie od wartości)
+     * @param callback
+     */
+    addOnChange(callback: () => void): void {
+        this.onChangeCallbacks.push(callback);
+    }
+    /**
+     * Zdarzenie wywoływane przy ustawieniu On na wyjściu
+     * @param callback
+     */
+    addOnSwitchOn(callback: () => void): void {
+        this.onSwitchOnCallbacks.push(callback);
+    }
+    /**
+     * Zdarzenie wywoływane przy ustawieniu Off na wyjściu
+     * @param callback
+     */
+    addOnSwitchOff(callback: () => void): void {
+        this.onSwitchOffCallbacks.push(callback);
+    }
+    /** Załącza wyjście */
+    switchOn(): void {
+        this.raw.execute(MethodType.SwitchOn);
+    }
+    /** Wyłącza wyjście */
+    switchOff(): void {
+        this.raw.execute(MethodType.SwitchOff);
+    }
+    /**
+     * Zwraca stan wyjścia: 1 - wyjście załączone, 0 - wyjście wyłączone, -1 - stan wyjścia nieznany (brak połączenia z centralką)
+     * @returns {ValueType}
+     */
+    get value(): ValueType {
+        return this.raw.get(PropertyType.Value);
+    }
+    /**
+     * Parametr definiujący, do którego wyjścia odnosi się obiekt
+     * @returns {number}
+     */
+    get nr(): number {
+        return this.raw.get(PropertyType.Nr);
+    }
+    set nr(value: number) {
+        this.raw.set(PropertyType.Nr, value);
+    }
+    /**
+     * Hasło użytkownika, dla _ zastosuje hasło administratora
+     * @returns {string}
+     */
+    get userPassword(): string {
+        return this.raw.get(PropertyType.UserPassword);
+    }
+    set userPassword(value: string) {
+        this.raw.set(PropertyType.UserPassword, value);
+    }
+}
+
+class OutputRemote implements IOutput {
+    constructor(private objectName: string, private gate: RemoteGate) {
+
+    }
+
+    /**
+     * Zdarzenie wywoływane przy zmianie stanu (niezależnie od wartości)
+     * @param callback
+     */
+    addOnChange(_callback: () => void): void {
+        // Remote events are not supported
+    }
+    /**
+     * Zdarzenie wywoływane przy ustawieniu On na wyjściu
+     * @param callback
+     */
+    addOnSwitchOn(_callback: () => void): void {
+        // Remote events are not supported
+    }
+    /**
+     * Zdarzenie wywoływane przy ustawieniu Off na wyjściu
+     * @param callback
+     */
+    addOnSwitchOff(_callback: () => void): void {
+        // Remote events are not supported
+    }
+
+    /** Załącza wyjście */
+    switchOn(): void {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .execute()
+            .addParameter(MethodType.SwitchOn)
+            .build();
+        this.gate.runScript(cmd!);
+    }
+
+    /** Wyłącza wyjście */
+    switchOff(): void {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .execute()
+            .addParameter(MethodType.SwitchOff)
+            .build();
+        this.gate.runScript(cmd!);
+    }
+
+    /**
+     * Zwraca stan wyjścia: 1 - wyjście załączone, 0 - wyjście wyłączone, -1 - stan wyjścia nieznany (brak połączenia z centralką)
+     * @returns {ValueType}
+     */
+    get value(): ValueType {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .get()
+            .addParameter(PropertyType.Value)
+            .build();
+        return this.gate.runScript(cmd!);
+    }
+
+    /**
+     * Parametr definiujący, do którego wyjścia odnosi się obiekt
+     * @returns {number}
+     */
+    get nr(): number {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .get()
+            .addParameter(PropertyType.Nr)
+            .build();
+        return this.gate.runScript(cmd!);
+    }
+
+    set nr(value: number) {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .set()
+            .addParameter(PropertyType.Nr)
+            .addParameter(value)
+            .build();
+        this.gate.runScript(cmd!);
+    }
+
+    /**
+     * Hasło użytkownika, dla _ zastosuje hasło administratora
+     * @returns {string}
+     */
+    get userPassword(): string {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .get()
+            .addParameter(PropertyType.UserPassword)
+            .build();
+        return this.gate.runScript(cmd!);
+    }
+
+    set userPassword(value: string) {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .set()
+            .addParameter(PropertyType.UserPassword)
+            .addParameter(value)
+            .build();
+        this.gate.runScript(cmd!);
+    }
+}
+
+export {
+    Output, OutputRaw, OutputRemote, ValueType
+}

package/dist/gate/satel/v1/satel.ts

@@ -0,0 +1,359 @@
+// Created from: packages/grenton-api/interfaces/object_satel_v1.xml, object name="Satel" version="1"
+
+import { rawExecutionBuilderFactory } from "../../../core/execution-builder"
+import { RemoteGate } from "../../../core/remote-gate"
+
+enum EventType {
+    OnConnected = 0,
+    OnDisconnected = 1,
+    OnError = 2
+}
+
+enum PropertyType {
+    State = 0,
+    LastError = 1,
+    IP = 2,
+    Port = 3,
+    AdminPassword = 4,
+    UpdateTime = 5,
+    EncryptionEnabled = 6,
+    EncryptionKey = 7
+}
+
+enum StateType {
+    Disconnected = 0,
+    Connected = 1
+}
+
+enum EncryptionEnabledType {
+    False = 0,
+    True = 1
+}
+
+declare class SatelRaw {
+    add_event(event: EventType, callback: () => void): void;
+    get(property: PropertyType): any;
+    set(property: PropertyType, value: any): void;
+    execute(method: number, ...args: any[]): any;
+}
+
+interface ISatel {
+    /**
+     * Zdarzenie wywoływane po nawiązaniu połączenia z centralką
+     * @param callback
+     */
+    addOnConnected: (callback: () => void) => void
+    /**
+     * Zdarzenie wywoływane po zerwaniu połączenia z centralką
+     * @param callback
+     */
+    addOnDisconnected: (callback: () => void) => void
+    /**
+     * Zdarzenie wywoływane po wystąpieniu błędu centralki (LastError)
+     * @param callback
+     */
+    addOnError: (callback: () => void) => void
+    /** Stan centralki: 0 - brak połączenia z centralką 1 - połączono z centralką */
+    readonly state: StateType
+    /** Ostatni kod błędu modułu ETHM (Satel): 0 - ok 1 - nieprawidłowe hasło */
+    readonly lastError: number
+    ip: string
+    /** Port modułu ETHM (Satel) */
+    port: number
+    /** Hasło administratora Satel */
+    adminPassword: string
+    /** Okres aktualizacji stanu centralki */
+    updateTime: number
+    /** Szyfrowanie: True - załączone False - wyłączone */
+    encryptionEnabled: EncryptionEnabledType
+    /** Klucz szyfrowania Satel */
+    encryptionKey: string
+}
+
+class Satel implements ISatel {
+    private onConnectedCallbacks: Array<() => void> = [];
+    private onDisconnectedCallbacks: Array<() => void> = [];
+    private onErrorCallbacks: Array<() => void> = [];
+
+    constructor(private raw: SatelRaw) {
+        this.raw.add_event(EventType.OnConnected, () => {
+            this.onConnectedCallbacks.forEach(callback => { callback(); });
+        });
+        this.raw.add_event(EventType.OnDisconnected, () => {
+            this.onDisconnectedCallbacks.forEach(callback => { callback(); });
+        });
+        this.raw.add_event(EventType.OnError, () => {
+            this.onErrorCallbacks.forEach(callback => { callback(); });
+        });
+    }
+
+    /**
+     * Zdarzenie wywoływane po nawiązaniu połączenia z centralką
+     * @param callback
+     */
+    addOnConnected(callback: () => void): void {
+        this.onConnectedCallbacks.push(callback);
+    }
+    /**
+     * Zdarzenie wywoływane po zerwaniu połączenia z centralką
+     * @param callback
+     */
+    addOnDisconnected(callback: () => void): void {
+        this.onDisconnectedCallbacks.push(callback);
+    }
+    /**
+     * Zdarzenie wywoływane po wystąpieniu błędu centralki (LastError)
+     * @param callback
+     */
+    addOnError(callback: () => void): void {
+        this.onErrorCallbacks.push(callback);
+    }
+    /**
+     * Stan centralki: 0 - brak połączenia z centralką 1 - połączono z centralką
+     * @returns {StateType}
+     */
+    get state(): StateType {
+        return this.raw.get(PropertyType.State);
+    }
+    /**
+     * Ostatni kod błędu modułu ETHM (Satel): 0 - ok 1 - nieprawidłowe hasło
+     * @returns {number}
+     */
+    get lastError(): number {
+        return this.raw.get(PropertyType.LastError);
+    }
+    get ip(): string {
+        return this.raw.get(PropertyType.IP);
+    }
+    set ip(value: string) {
+        this.raw.set(PropertyType.IP, value);
+    }
+    /**
+     * Port modułu ETHM (Satel)
+     * @returns {number}
+     */
+    get port(): number {
+        return this.raw.get(PropertyType.Port);
+    }
+    set port(value: number) {
+        this.raw.set(PropertyType.Port, value);
+    }
+    /**
+     * Hasło administratora Satel
+     * @returns {string}
+     */
+    get adminPassword(): string {
+        return this.raw.get(PropertyType.AdminPassword);
+    }
+    set adminPassword(value: string) {
+        this.raw.set(PropertyType.AdminPassword, value);
+    }
+    /**
+     * Okres aktualizacji stanu centralki
+     * @returns {number}
+     */
+    get updateTime(): number {
+        return this.raw.get(PropertyType.UpdateTime);
+    }
+    set updateTime(value: number) {
+        this.raw.set(PropertyType.UpdateTime, value);
+    }
+    /**
+     * Szyfrowanie: True - załączone False - wyłączone
+     * @returns {EncryptionEnabledType}
+     */
+    get encryptionEnabled(): EncryptionEnabledType {
+        return this.raw.get(PropertyType.EncryptionEnabled);
+    }
+    set encryptionEnabled(value: EncryptionEnabledType) {
+        this.raw.set(PropertyType.EncryptionEnabled, value);
+    }
+    /**
+     * Klucz szyfrowania Satel
+     * @returns {string}
+     */
+    get encryptionKey(): string {
+        return this.raw.get(PropertyType.EncryptionKey);
+    }
+    set encryptionKey(value: string) {
+        this.raw.set(PropertyType.EncryptionKey, value);
+    }
+}
+
+class SatelRemote implements ISatel {
+    constructor(private objectName: string, private gate: RemoteGate) {
+
+    }
+
+    /**
+     * Zdarzenie wywoływane po nawiązaniu połączenia z centralką
+     * @param callback
+     */
+    addOnConnected(_callback: () => void): void {
+        // Remote events are not supported
+    }
+    /**
+     * Zdarzenie wywoływane po zerwaniu połączenia z centralką
+     * @param callback
+     */
+    addOnDisconnected(_callback: () => void): void {
+        // Remote events are not supported
+    }
+    /**
+     * Zdarzenie wywoływane po wystąpieniu błędu centralki (LastError)
+     * @param callback
+     */
+    addOnError(_callback: () => void): void {
+        // Remote events are not supported
+    }
+
+    /**
+     * Stan centralki: 0 - brak połączenia z centralką 1 - połączono z centralką
+     * @returns {StateType}
+     */
+    get state(): StateType {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .get()
+            .addParameter(PropertyType.State)
+            .build();
+        return this.gate.runScript(cmd!);
+    }
+
+    /**
+     * Ostatni kod błędu modułu ETHM (Satel): 0 - ok 1 - nieprawidłowe hasło
+     * @returns {number}
+     */
+    get lastError(): number {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .get()
+            .addParameter(PropertyType.LastError)
+            .build();
+        return this.gate.runScript(cmd!);
+    }
+
+    get ip(): string {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .get()
+            .addParameter(PropertyType.IP)
+            .build();
+        return this.gate.runScript(cmd!);
+    }
+
+    set ip(value: string) {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .set()
+            .addParameter(PropertyType.IP)
+            .addParameter(value)
+            .build();
+        this.gate.runScript(cmd!);
+    }
+
+    /**
+     * Port modułu ETHM (Satel)
+     * @returns {number}
+     */
+    get port(): number {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .get()
+            .addParameter(PropertyType.Port)
+            .build();
+        return this.gate.runScript(cmd!);
+    }
+
+    set port(value: number) {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .set()
+            .addParameter(PropertyType.Port)
+            .addParameter(value)
+            .build();
+        this.gate.runScript(cmd!);
+    }
+
+    /**
+     * Hasło administratora Satel
+     * @returns {string}
+     */
+    get adminPassword(): string {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .get()
+            .addParameter(PropertyType.AdminPassword)
+            .build();
+        return this.gate.runScript(cmd!);
+    }
+
+    set adminPassword(value: string) {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .set()
+            .addParameter(PropertyType.AdminPassword)
+            .addParameter(value)
+            .build();
+        this.gate.runScript(cmd!);
+    }
+
+    /**
+     * Okres aktualizacji stanu centralki
+     * @returns {number}
+     */
+    get updateTime(): number {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .get()
+            .addParameter(PropertyType.UpdateTime)
+            .build();
+        return this.gate.runScript(cmd!);
+    }
+
+    set updateTime(value: number) {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .set()
+            .addParameter(PropertyType.UpdateTime)
+            .addParameter(value)
+            .build();
+        this.gate.runScript(cmd!);
+    }
+
+    /**
+     * Szyfrowanie: True - załączone False - wyłączone
+     * @returns {EncryptionEnabledType}
+     */
+    get encryptionEnabled(): EncryptionEnabledType {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .get()
+            .addParameter(PropertyType.EncryptionEnabled)
+            .build();
+        return this.gate.runScript(cmd!);
+    }
+
+    set encryptionEnabled(value: EncryptionEnabledType) {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .set()
+            .addParameter(PropertyType.EncryptionEnabled)
+            .addParameter(value)
+            .build();
+        this.gate.runScript(cmd!);
+    }
+
+    /**
+     * Klucz szyfrowania Satel
+     * @returns {string}
+     */
+    get encryptionKey(): string {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .get()
+            .addParameter(PropertyType.EncryptionKey)
+            .build();
+        return this.gate.runScript(cmd!);
+    }
+
+    set encryptionKey(value: string) {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .set()
+            .addParameter(PropertyType.EncryptionKey)
+            .addParameter(value)
+            .build();
+        this.gate.runScript(cmd!);
+    }
+}
+
+export {
+    Satel, SatelRaw, SatelRemote, StateType, EncryptionEnabledType
+}