README.md

Home Assistant REST Api Client

Installation

Option 1) From Maven Central (recommended)

• Add maven dependency

  • <dependency>
        <groupId>com.mgustran</groupId>
        <artifactId>home-assistant-rest-client</artifactId>
        <version>1.0.1</version>
    </dependency>
    

Option 2) Jitpack

You can use jitpack to add this dependency:

• Add jitpack repository:

  • <repositories>
       <repository>
           <id>jitpack.io</id>
           <url>https://jitpack.io</url>
       </repository>
    </repositories> 
    

• Add maven dependency:

  • <dependency>
        <groupId>com.github.mgustran</groupId>
        <artifactId>home-assistant-rest-client</artifactId>
        <version>1.0.1</version>
    <dependency>
    

Option 3) Local

• Download project and install the lib to your local:
  • mvn clean install

Usage

• Set Config values

  • put those properties in application.properties file inside your project resources' folder / classpath:
    • homeassistant.host=http://example.com:8123 # HA host
    • homeassistant.token=eyJ0eXAiOiJ... # HA Long Lived Token

• To use the different methods see the tests under src/test/java/com/mgustran/homeassistant/client

About the lib

• This library provides a simple way to communicate with Home Assistant Rest API

• Works with reverse proxy (http & https) configuration

• This library works with Java >= 8, Maven and has some dependencies already provided:

  • lombok : 1.18.24
  • jackson-databind : 2.14.0-rc1
  • jackson-datatype-jsr310 : 2.14.0-rc1
  • junit-jupiter (test) : 5.9.1

Contributing

You are invited to participate and contribute to the improvement of this lib, but i want to stay clear about some things:

I tried to make this project not dependent on many libs, to be easily integrated with other different projects, so..:

• I don't want to put more deps on project, unless they optimize significantly something

License

• see LICENSE.txt