kheos

Expose heos as RESTful interface.

License	The Apache Software License, Version 2.0
GroupId	io.honnix
ArtifactId	kheos
Last Version	0.0.9
Release Date	Dec 7, 2017
Type	pom
Description	kheos Expose heos as RESTful interface.
Project URL	https://github.com/honnix/kheos
Source Code Management	https://github.com/honnix/kheos

Download kheos

Filename	Size
kheos-0.0.9.pom	14 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.honnix/kheos/ -->
<dependency>
    <groupId>io.honnix</groupId>
    <artifactId>kheos</artifactId>
    <version>0.0.9</version>
    <type>pom</type>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.honnix/kheos/
implementation 'io.honnix:kheos:0.0.9'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.honnix/kheos/
implementation ("io.honnix:kheos:0.0.9")

Apache Buildr

'io.honnix:kheos:pom:0.0.9'

Apache Ivy

<dependency org="io.honnix" name="kheos" rev="0.0.9">
  <artifact name="kheos" type="pom" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.honnix', module='kheos', version='0.0.9')
)

Scala SBT

libraryDependencies += "io.honnix" % "kheos" % "0.0.9"

Leiningen

[io.honnix/kheos "0.0.9"]

Dependencies

compile (2)

Group / Artifact	Type	Version
org.jetbrains.kotlin : kotlin-stdlib-jdk8	jar	1.2.0
org.slf4j : slf4j-api	jar	1.7.25

test (4)

Group / Artifact	Type	Version
org.slf4j : slf4j-nop	jar	1.7.25
org.mockito : mockito-core	jar	2.11.0
io.kotlintest : kotlintest	jar	2.0.7
junit : junit	jar	4.12

Project Modules

• kheos-common
• kheos-lib
• kheos-service
• kheos-client
• kheos-report

kheos

A Kotlin implementation of HEOS API Spec.

Why

For unknown reason, HEOS decided to go with plain socket which is anything than being modern (despite that many commands do return JSON!)

The goal of this project is to add an gRPC interface to make it easier interacting with HEOS from other services. And of course we need common models, core lib, service and client to make it complete.

Usage

Prerequisite

JDK8 and Maven.

To build

$ git clone [email protected]:honnix/kheos.git
$ mvn package

This gives you a Docker image as bonus that you can ship directly, or you can use a pre-built image here.

To start the service:

$ java -jar kheos-service/target/kheos-service.jar

Or

docker run -d honnix/kheos-service:<tag>

By default the service listens on 8888 and can be configured by env GRPC_PORT.

Use KHEOS_HEOS_HOST to configure where to find your HEOS.

For details and other configurations, refer to application.conf.

To start hacking

Import the maven project to IntelliJ (it works nicer with Kotlin, of course) and start sending PRs!

kheos-proto

The place where all protobuf files are stored.

kheos-common

This module contains mostly data classes and utilities.

kheos-lib

This module contains core libraries that connect to HEOS, send heartbeat and commands, and discover HEOS speakers.

Test cases are the best place to get a quick idea how to use the lib.

kheos-service

This module exposes gRPC interface to interact with HEOS.

Versions

Version
0.0.9 Dec 7, 2017
0.0.8 Dec 1, 2017
0.0.7 Nov 30, 2017
0.0.6 Nov 23, 2017
0.0.5 Nov 23, 2017
0.0.4 Nov 18, 2017
0.0.3 Nov 15, 2017