AnimatedLEDStrip Client

A helper library for communicating with an AnimatedLEDStrip server

License	MIT License
Categories	CLI User Interface
GroupId	io.github.animatedledstrip
ArtifactId	animatedledstrip-client-jvm
Last Version	1.0.1
Release Date	Apr 23, 2021
Type	pom.sha512
Description	AnimatedLEDStrip Client A helper library for communicating with an AnimatedLEDStrip server
Project URL	https://github.com/AnimatedLEDStrip/client-kotlin-mpp
Source Code Management	https://github.com/AnimatedLEDStrip/client-kotlin-mpp

Download animatedledstrip-client-jvm

Filename	Size
animatedledstrip-client-jvm-1.0.1.pom
animatedledstrip-client-jvm-1.0.1-sources.jar	2 KB
animatedledstrip-client-jvm-1.0.1-javadoc.jar	261 bytes

Dependencies

compile (5)

Group / Artifact	Type	Version
io.github.animatedledstrip : animatedledstrip-core-jvm	jar	1.0.1
org.jetbrains.kotlin : kotlin-stdlib-jdk8	jar	1.4.32
io.ktor : ktor-client-core-jvm	jar	1.5.2
io.ktor : ktor-client-serialization-jvm	jar	1.5.2
org.jetbrains.kotlin : kotlin-stdlib-common	jar	1.4.32

Project Modules

There are no modules declared in this project.

AnimatedLEDStrip Client Library for Kotlin/MPP

This library allows a Kotlin/JVM or Kotlin/JS client to communicate with an AnimatedLEDStrip server.

Creating an ALSHttpClient

To create a HTTP client, run ALSHttpClient(clientEngine, ip).

clientEngine is a Ktor HttpClientEngineFactory

val client = ALSHttpClient(CIO, ip = "10.0.0.254")

An optional configuration for the Ktor engine can be passed as a third argument. Any configuration should include a JSON feature that uses the AnimatedLEDStrip serializer:

import animatedledstrip.communication.serializer as alsSerializer

install(JsonFeature) {
    serializer = KotlinxSerializer(alsSerializer)
}

Communicating with the Server

This library follows the conventions laid out for AnimatedLEDStrip client libraries.

Versions

Version
1.0.1 Apr 23, 2021