https://github.com/teverett/hsopenapi

An OpenAPI wrapper for the HomeSeer JSON API
https://github.com/teverett/hsopenapi

homeseer openapi

Last synced: 3 days ago
JSON representation

An OpenAPI wrapper for the HomeSeer JSON API

• Host: GitHub
• URL: https://github.com/teverett/hsopenapi
• Owner: teverett
• License: bsd-3-clause
• Created: 2020-09-13T21:48:35.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-04-11T18:44:35.000Z (almost 4 years ago)
• Last Synced: 2024-11-24T10:42:39.198Z (2 months ago)
• Topics: homeseer, openapi
• Language: Java
• Homepage:
• Size: 58.6 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![CI](https://github.com/teverett/hsopenapi/workflows/CI/badge.svg)

# HomeSeer hsOpenAPI

A Java [OpenAPI](https://en.wikipedia.org/wiki/OpenAPI_Specification) bridge for HomeSeer. 

hsOpenAPI is one of numerous HomeSeer support applications created by khubla.com, including

* [hsClient](https://github.com/teverett/hsclient)

* [hsInflux](https://github.com/teverett/hsinflux)

* [hsMQTT](https://github.com/teverett/hsOpenAPI)

* [hsOpenAPI](https://github.com/teverett/hsOpenAPI)

hsOpenAPI uses [hsClient](https://github.com/teverett/hsclient)

## API Documentation

API Documentation is [here](apidocumentation/README.md) 

## Usage

Just run the executable jar after compilation. hsOpenAPI will be available on port http/8080 by default.

For example, you can get the device list at:

`http://localhost:8080/homeseer/devices`

## OpenAPI

The OpenAPI spec for hsOpenAPI is [here](https://github.com/teverett/hsOpenAPI/blob/master/src/main/resources/swagger.yaml)

## License

hsOpenAPI is distributed under the BSD 3-Clause License.

## Configuration

hsOpenAPI is configured via the file "hsopenapi.properties".  A typical example is

```

# HomeSeer

hsurl=http://192.168.75.129/JSON

hsuser=HOMESEERUSERNAME

hspassword=HOMESEERPASSWORD

http.port=8080