remootio-angular v0.1.0

Remootio Angular Service

This service is a conversion of the Remootio API Client for Node.js module for use in Angular. This module is a Angular Service written using Angular 15.0.0.

Remootio is a smart gate and garage door controller product.

I created this service for use in my own project to work with my Ghost Controls gate.

Install

npm install crypto-js --save
npm install remootio-angular --save

Usage

Step 1

Import the module into your app module

import { RemootioAngularService } from 'remootio-angular';

...

providers: [
  RemootioAngularService
]

Step 2

Inject the service into your component's TypeScript constructor and subscribe to state changes.

constructor(private remootioService: RemootioAngularService) { };

Example

In your component TypeScript file create a public field variable that is a Subject<IGateState>()

public gateState$ = new Subject<IGateState>();

We wire up the gateState$ in the constructor.

constructor(private remootioService: RemootioAngularService) {
  remootioService.gateState$.subscribe(gateState => {
    this.gateState$.next(gateState);
  })
};

This can then be used in the component to display if the gate is open or closed.

<div *ngIf="isAuthenticated">
  <button (click)='closeGate()' [disabled]="!(gateState$ | async)?.isOpen">Close</button>
  &nbsp;
  <button (click)='openGate()' [disabled]="(gateState$ | async)?.isOpen">Open</button>
</div>

In this example if the gate is Open then the Close button will be active and Open button will be disabled. By using the async pipe when the underlying observable gateState$ receives data the buttons will change.

We still need to connect to the Remootio device and to do that we call the connect method in the ngOnInit() method:

ngOnInit(): void {
  this.remootioService.connect({
    deviceIp: '{remootioDeviceIp}',
    apiSecretKey: '{apiSecretKey}',
    apiAuthKey: '{apiAuthKey}',
    autoReconnect: true
  });
}

This will start the WebSocket connection to the Remootio and authenticate. If you don't specifiy sendPingMessageEveryXMs in the IRemootioDeviceConfig when calling the connect method, it will automatically be set to 60 seconds. This keeps the connection alive, so you continue to receive events.

You can also Open or Close the gate. In the HTML above each button is bound to a method on the (click) event.

closeGate() {
  this.remootioService.closeGate();
}

openGate() {
  this.remootioService.openGate();
}

Each method calls its corresponding action in the remootioService.

The last part is the *ngIf="isAuthenticated" in the outside <div>. This is here so the buttons don't show up unless we have an authenticated connection to the Remootio device. You can expose this in your components TypeScipt.

get isAuthenticated(): boolean {
  return this.remootioService.isAuthenticated;
}