# uCOMmandIt (UCI) - A Home Assistant Class and API


<!-- find and replace the package name to match -->
<!-- [![Build Status](https://img.shields.io/travis/uCOMmandIt/uci-base.svg?branch=master)](https://travis-ci.org/uCOMmandIt/uci-base)
[![Inline docs](http://inch-ci.org/github/uCOMmandIt/uci-base.svg?branch=master)](http://inch-ci.org/github/uCOMmandIt/uci-base)
[![Dependencies](https://img.shields.io/david/uCOMmandIt/uci-base.svg)](https://david-dm.org/uCOMmandIt/uci-base)
[![devDependencies](https://img.shields.io/david/dev/uCOMmandIt/uci-base.svg)](https://david-dm.org/uCOMmandIt/uci-base?type=dev)
[![codecov](https://img.shields.io/codecov/c/github/uCOMmandIt/uci-base/master.svg)](https://codecov.io/gh/uCOMmandIt/uci-base) -->


## What is it

This module allows one to communicate with a Home Assistant instance via their websocket api

## What's it good for

Easily replace most of the limited HA yaml script and automation with nodejs code.

## Prerequisites

You'll of course need nodejs running and either npm or yarn.  UCI tries to keep node as current as possible during development so use the latest version 12.x for best results or at

## OS and Node Support


## Terminology


## The HA Websocket Packet 'Protocol'


## Getting Started

## Creating an Instance

## Extending This Class

## Options

## API