https://github.com/Smarteon/loxone-client-kotlin

Kotlin multiplatform implementation of the Loxone™ communication protocol.
https://github.com/Smarteon/loxone-client-kotlin

kotlin-library kotlin-multiplatform loxone loxone-binding loxone-communication-protocol loxone-kotlin loxone-miniserver

Last synced: 3 months ago
JSON representation

Kotlin multiplatform implementation of the Loxone™ communication protocol.

• Host: GitHub
• URL: https://github.com/Smarteon/loxone-client-kotlin
• Owner: Smarteon
• License: bsd-3-clause
• Created: 2023-12-19T10:31:33.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-12-05T11:20:23.000Z (6 months ago)
• Last Synced: 2024-12-05T12:24:15.582Z (6 months ago)
• Topics: kotlin-library, kotlin-multiplatform, loxone, loxone-binding, loxone-communication-protocol, loxone-kotlin, loxone-miniserver
• Language: Kotlin
• Homepage: https://smarteon.cz/index_en.html
• Size: 264 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Loxone Kotlin Client [![Maven Central](https://maven-badges.herokuapp.com/maven-central/cz.smarteon.loxone/loxone-client-kotlin/badge.svg)](https://maven-badges.herokuapp.com/maven-central/cz-smarteon-loxone/loxone-client-kotlin) [![codecov](https://codecov.io/gh/Smarteon/loxone-client-kotlin/branch/master/graph/badge.svg)](https://codecov.io/gh/Smarteon/loxone-client-kotlin)

Experimental Kotlin implementation of the Loxone™ communication protocol.

* *Supported miniservers*: miniserver gen. 1, miniserver gen. 2, miniserver GO

* *Supported firmware*: **10.4.0.0** and ongoing

Most of the library is trying to behave according to 

[Loxone API documentation](https://www.loxone.com/enen/kb/api/) 

and [Loxone webservices](https://www.loxone.com/enen/kb/web-services/).  

*Disclaimer:*

This is an experimental project, which means:

* no further development is guaranteed

* there can be serious bugs 

Any feedback or help is welcomed.

The predecessor of this project is [loxone-java](https://github.com/Smarteon/loxone-java) library. For more complete experience on JVM, consider using it. There is a plan to merge both projects in the future in some way.

 

## Usage

In order to use version from master which is not released, it's needed build and publish it locally first:

```bash

./gradlew build publishToMavenLocal

```

### Maven

```xml

    cz.smarteon.loxone

    loxone-client-kotlin

    

```

### Gradle

```groovy

compile group: 'cz.smarteon.loxone', name: 'loxone-client-kotlin', version: 'desired version'

```

or

```kotlin

implementation("cz.smarteon.loxone", "loxone-client.kotlin", "desired version")

```