grenton-ts 1.0.0

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

@@ -0,0 +1,171 @@
+// Created from: packages/grenton-api/interfaces/object_satel_input_v1.xml, object name="SatelInput" 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
+}
+
+enum ValueType {
+    Normal = 0,
+    Violated = 1
+}
+
+declare class SatelInputRaw {
+    add_event(event: EventType, callback: () => void): void;
+    get(property: PropertyType): any;
+    set(property: PropertyType, value: any): void;
+    execute(method: number, ...args: any[]): any;
+}
+
+interface ISatelInput {
+    /**
+     * Zdarzenie wywoływane przy zmianie stanu (niezależnie od wartości)
+     * @param callback
+     */
+    addOnChange: (callback: () => void) => void
+    /**
+     * Zdarzenie wywoływane przy ustawieniu Violated na wejściu
+     * @param callback
+     */
+    addOnSwitchOn: (callback: () => void) => void
+    /**
+     * Zdarzenie wywoływane przy ustawieniu Normal na wejściu
+     * @param callback
+     */
+    addOnSwitchOff: (callback: () => void) => void
+    /** Zwraca stan wejścia: 1 - wejście naruszone, 0 - wejście nienaruszone, -1 - stan wejścia nieznany (brak połączenia z centralką) */
+    readonly value: ValueType
+    /** Parametr definiujący, do którego wejścia odnosi się obiekt */
+    nr: number
+}
+
+class SatelInput implements ISatelInput {
+    private onChangeCallbacks: Array<() => void> = [];
+    private onSwitchOnCallbacks: Array<() => void> = [];
+    private onSwitchOffCallbacks: Array<() => void> = [];
+
+    constructor(private raw: SatelInputRaw) {
+        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 Violated na wejściu
+     * @param callback
+     */
+    addOnSwitchOn(callback: () => void): void {
+        this.onSwitchOnCallbacks.push(callback);
+    }
+    /**
+     * Zdarzenie wywoływane przy ustawieniu Normal na wejściu
+     * @param callback
+     */
+    addOnSwitchOff(callback: () => void): void {
+        this.onSwitchOffCallbacks.push(callback);
+    }
+    /**
+     * Zwraca stan wejścia: 1 - wejście naruszone, 0 - wejście nienaruszone, -1 - stan wejścia nieznany (brak połączenia z centralką)
+     * @returns {ValueType}
+     */
+    get value(): ValueType {
+        return this.raw.get(PropertyType.Value);
+    }
+    /**
+     * Parametr definiujący, do którego wejś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);
+    }
+}
+
+class SatelInputRemote implements ISatelInput {
+    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 Violated na wejściu
+     * @param callback
+     */
+    addOnSwitchOn(_callback: () => void): void {
+        // Remote events are not supported
+    }
+    /**
+     * Zdarzenie wywoływane przy ustawieniu Normal na wejściu
+     * @param callback
+     */
+    addOnSwitchOff(_callback: () => void): void {
+        // Remote events are not supported
+    }
+
+    /**
+     * Zwraca stan wejścia: 1 - wejście naruszone, 0 - wejście nienaruszone, -1 - stan wejś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 wejś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!);
+    }
+}
+
+export {
+    SatelInput, SatelInputRaw, SatelInputRemote, ValueType
+}

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

@@ -0,0 +1,240 @@
+// Created from: packages/grenton-api/interfaces/object_satel_output_v1.xml, object name="SatelOutput" 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 SatelOutputRaw {
+    add_event(event: EventType, callback: () => void): void;
+    get(property: PropertyType): any;
+    set(property: PropertyType, value: any): void;
+    execute(method: MethodType, ...args: any[]): any;
+}
+
+interface ISatelOutput {
+    /**
+     * 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 SatelOutput implements ISatelOutput {
+    private onChangeCallbacks: Array<() => void> = [];
+    private onSwitchOnCallbacks: Array<() => void> = [];
+    private onSwitchOffCallbacks: Array<() => void> = [];
+
+    constructor(private raw: SatelOutputRaw) {
+        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 SatelOutputRemote implements ISatelOutput {
+    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 {
+    SatelOutput, SatelOutputRaw, SatelOutputRemote, ValueType
+}

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

@@ -0,0 +1,235 @@
+// Created from: packages/grenton-api/interfaces/object_satel_zone_v1.xml, object name="SatelZone" version="1"
+
+import { rawExecutionBuilderFactory } from "../../../core/execution-builder"
+import { RemoteGate } from "../../../core/remote-gate"
+
+enum EventType {
+    OnChange = 0,
+    OnArm = 1,
+    OnDisarm = 2
+}
+
+enum PropertyType {
+    Value = 0,
+    Nr = 1,
+    UserPassword = 2
+}
+
+enum MethodType {
+    ArmZone = 0,
+    DisarmZone = 1
+}
+
+declare class SatelZoneRaw {
+    add_event(event: EventType, callback: () => void): void;
+    get(property: PropertyType): any;
+    set(property: PropertyType, value: any): void;
+    execute(method: MethodType, ...args: any[]): any;
+}
+
+interface ISatelZone {
+    /**
+     * Zdarzenie wywoływane przy zmianie stanu (niezależnie od wartości)
+     * @param callback
+     */
+    addOnChange: (callback: () => void) => void
+    /**
+     * Zdarzenie wywoływane przy uzbrojeniu strefy
+     * @param callback
+     */
+    addOnArm: (callback: () => void) => void
+    /**
+     * Zdarzenie wywoływane przy rozbrojeniu strefy
+     * @param callback
+     */
+    addOnDisarm: (callback: () => void) => void
+    /** Uzbraja strefę */
+    armZone: () => void
+    /** Rozbraja strefę */
+    disarmZone: () => void
+    /** Zwraca stan strefy: 1 - strefa uzbrojona, 0 - strefa rozbrojona, -1 - stan strefy nieznany (brak połączenia z centralką) */
+    readonly value: number
+    /** Parametr definiujący, do której strefy odnosi się obiekt */
+    nr: number
+    /** Hasło użytkownika, dla '_' zastosuje hasło administratora */
+    userPassword: string
+}
+
+class SatelZone implements ISatelZone {
+    private onChangeCallbacks: Array<() => void> = [];
+    private onArmCallbacks: Array<() => void> = [];
+    private onDisarmCallbacks: Array<() => void> = [];
+
+    constructor(private raw: SatelZoneRaw) {
+        this.raw.add_event(EventType.OnChange, () => {
+            this.onChangeCallbacks.forEach(callback => { callback(); });
+        });
+        this.raw.add_event(EventType.OnArm, () => {
+            this.onArmCallbacks.forEach(callback => { callback(); });
+        });
+        this.raw.add_event(EventType.OnDisarm, () => {
+            this.onDisarmCallbacks.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 uzbrojeniu strefy
+     * @param callback
+     */
+    addOnArm(callback: () => void): void {
+        this.onArmCallbacks.push(callback);
+    }
+    /**
+     * Zdarzenie wywoływane przy rozbrojeniu strefy
+     * @param callback
+     */
+    addOnDisarm(callback: () => void): void {
+        this.onDisarmCallbacks.push(callback);
+    }
+    /** Uzbraja strefę */
+    armZone(): void {
+        this.raw.execute(MethodType.ArmZone);
+    }
+    /** Rozbraja strefę */
+    disarmZone(): void {
+        this.raw.execute(MethodType.DisarmZone);
+    }
+    /**
+     * Zwraca stan strefy: 1 - strefa uzbrojona, 0 - strefa rozbrojona, -1 - stan strefy nieznany (brak połączenia z centralką)
+     * @returns {number}
+     */
+    get value(): number {
+        return this.raw.get(PropertyType.Value);
+    }
+    /**
+     * Parametr definiujący, do której strefy 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 SatelZoneRemote implements ISatelZone {
+    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 uzbrojeniu strefy
+     * @param callback
+     */
+    addOnArm(_callback: () => void): void {
+        // Remote events are not supported
+    }
+    /**
+     * Zdarzenie wywoływane przy rozbrojeniu strefy
+     * @param callback
+     */
+    addOnDisarm(_callback: () => void): void {
+        // Remote events are not supported
+    }
+
+    /** Uzbraja strefę */
+    armZone(): void {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .execute()
+            .addParameter(MethodType.ArmZone)
+            .build();
+        this.gate.runScript(cmd!);
+    }
+
+    /** Rozbraja strefę */
+    disarmZone(): void {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .execute()
+            .addParameter(MethodType.DisarmZone)
+            .build();
+        this.gate.runScript(cmd!);
+    }
+
+    /**
+     * Zwraca stan strefy: 1 - strefa uzbrojona, 0 - strefa rozbrojona, -1 - stan strefy nieznany (brak połączenia z centralką)
+     * @returns {number}
+     */
+    get value(): number {
+        const cmd: string | null = rawExecutionBuilderFactory(this.objectName)
+            .get()
+            .addParameter(PropertyType.Value)
+            .build();
+        return this.gate.runScript(cmd!);
+    }
+
+    /**
+     * Parametr definiujący, do której strefy 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 {
+    SatelZone, SatelZoneRaw, SatelZoneRemote
+}