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
Last Version	1.0.1
Release Date	Apr 23, 2021
Type	jar
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

Filename	Size
animatedledstrip-client-1.0.1.pom
animatedledstrip-client-1.0.1.jar	28 KB
animatedledstrip-client-1.0.1-sources.jar	6 KB
animatedledstrip-client-1.0.1-javadoc.jar	362 KB

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/io.github.animatedledstrip/animatedledstrip-client/ -->
<dependency>
    <groupId>io.github.animatedledstrip</groupId>
    <artifactId>animatedledstrip-client</artifactId>
    <version>1.0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/io.github.animatedledstrip/animatedledstrip-client/
implementation 'io.github.animatedledstrip:animatedledstrip-client:1.0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/io.github.animatedledstrip/animatedledstrip-client/
implementation ("io.github.animatedledstrip:animatedledstrip-client:1.0.1")

Apache Buildr

'io.github.animatedledstrip:animatedledstrip-client:jar:1.0.1'

Apache Ivy

<dependency org="io.github.animatedledstrip" name="animatedledstrip-client" rev="1.0.1">
  <artifact name="animatedledstrip-client" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='io.github.animatedledstrip', module='animatedledstrip-client', version='1.0.1')
)

Scala SBT

libraryDependencies += "io.github.animatedledstrip" % "animatedledstrip-client" % "1.0.1"

Leiningen

[io.github.animatedledstrip/animatedledstrip-client "1.0.1"]

Dependencies

compile (4)

Group / Artifact	Type	Version
io.github.animatedledstrip : animatedledstrip-core	jar	1.0.1
io.ktor : ktor-client-core	jar	1.5.2
io.ktor : ktor-client-serialization	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
0.7 Aug 3, 2020
0.6 Jan 18, 2020
0.5 Sep 29, 2019
0.4 Sep 20, 2019
0.3 Aug 29, 2019
0.3-alpha Jan 20, 2019
0.2 Jan 15, 2019
0.1 Jan 14, 2019