TypeScript/RXJS Node.js api for HomeAssistant

It's simple reactive way of access and control HomeAssistant using the
websocket api.

This is very first versions of the library and some functionality is missing...

Please, do not hasitate to create an issues if you will find any bug or missing functionality.

Installation

``bash
$ npm i --save tsnode-homeassistant
`

Or use seed project

https://github.com/troyanskiy/tsnode-homeassistant-seed

Usage example

`typescript
import { HomeAssistant, IHAEvent } from 'tsnode-homeassistant';
import { IButtonEventData } from './data';
import { CONFIG } from './config';
import { map } from 'rxjs/operators';

// Create the HomeAssistant instance and connect to the HA server
const ha = new HomeAssistant(CONFIG);

ha
.events // Events object
.select('deconz_event') // Select HA events
.pipe(
map(($event: IHAEvent) => $event.data) // Map event
)
.subscribe(data => { // Subscribe to events

console.log('The event', data);

});

ha
.states
.onChange
.subscribe(state => console.log(state));

`

API

1 HomeAssistant

$3

connectionStatus$: Observable

$3

connectionStatus: HAConnectionStatus

$3

ready$: Observable

$3

haVersion: string

$3

events: HomeAssistantEvents

Details below

$3

service: HomeAssistantService

Details below

$3

entities: HomeAssistantEntities

Details below

2 Events

Available as object on HomeAssistant instance .events

$3

`typescript
*.events.select(eventType: string): Observable>
`

`typescript
export interface IHAEvent {
data: T; // event data
event_type: string; // event type or name
time_fired: string; // time of event fire
origin: string; // event origin
context?: IHAEventContext;
}

export interface IHAEventContext {
id: string;
parent_id: string | null;
user_id: string | null;
}
`

#### Example

Above

3 Service

Available as object on HomeAssistant instance .service

$3

`typescript
*.service.call(domain: HADomain, service: HAServiceActionType, serviceDataOrEntity?: any): Observable
`

Will return an observable with service execution result

#### Examples

`typescript
ha
.service
.call(
HADomain.Light,
HAServiceType.TurnOn,
'light.EntityId1'
)
`

`typescript
ha
.service
.call(
HADomain.Light,
HAServiceType.TurnOn,
'EntityId1'
)
`

`typescript
ha
.service
.call(
HADomain.Switch,
HAServiceType.TurnOff,
['EntityId1', 'switch.EntityId2']
)
`

`typescript
ha
.service
.call(
HADomain.Switch,
HAServiceType.Toggle,
{
entity_id: ['EntityId1', 'EntityId2']
}
)
`

$3

`typescript
toggle(domain: HADomain, entities: string[] | string, force?: boolean): Observable
`
Will return an observable with service execution result

If
* force === true it will call TurnOn service
* force === false it will call TurnOff service
* force is missing will call Toggle service


#### Example

`typescript
ha
.service
.toggle(
HADomain.Switch,
['EntityId1', 'EntityId2']
)
`

4 Entities / States

Available as object on HomeAssistant instance .entities

All the entities/states are loaded and saved in the memory every time
when Node.js instance is connected to the HomeAssistant server

$3

`typescript
*.entities.onChange: Subject
`

#### Examples

`typescript
ha
.entities
.onChange
.pipe(
filter(entity => entity.id === 'MyEntityId')
)
.subscribe(entity => {
// do something with new state
console.log('Received new state of entity', entity);
})
`

$3

Will call HA to get all the states, updates them in the memory and returns as observable resolution

`typescript
*.entities.fetchEntities(): Observable
`

$3

Will return entity from memory or null if not found

`typescript
*.entities.getState(entityId: string): HAEntity | null
``