Code Monkey home page Code Monkey logo

homeassistant-ts's Introduction

๐Ÿ  Home Assistant - Typescript SDK

CI

๐Ÿ“š SDK Docs

๐Ÿ“š OpenAPI 3.x Spec

This is typescript REST API client for the Home Assistant API. Allows you to interact with your Home Assistant instance from Typescript/JS projects.

โšก Usage

How to use the library

๐Ÿ“ฆ Installation

npm install @brittonhayes/homeassistant-ts

๐Ÿš€ Quickstart

Create a client

import * as homeassistant from '@brittonhayes/homeassistant-ts';

const ha = new homeassistant.Client({
    baseUrl: process.env.HASS_URL,
    token: process.env.HASS_TOKEN,
});

List all home assistant services

const services = await ha.services.list();
console.log(services);

List all logbook entries (as plaintext)

const logs = await ha.logbook.list();
console.log(logs);

Retrieve all calendar events from a calendar

const calendar = await ha.calendars.retrieve('calendar.calendar_name');
console.log(calendar);

Development

# Install dependencies
npm install
# Format the code
npm run format
# Build the library
npm run build

homeassistant-ts's People

Contributors

brittonhayes avatar dependabot[bot] avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.