AnimatedLEDStrip Client

A helper library for communicating with an AnimatedLEDStrip server

License

License

Categories

Categories

CLI User Interface
GroupId

GroupId

io.github.animatedledstrip
ArtifactId

ArtifactId

animatedledstrip-client
Last Version

Last Version

1.0.1
Release Date

Release Date

Type

Type

jar
Description

Description

AnimatedLEDStrip Client
A helper library for communicating with an AnimatedLEDStrip server
Project URL

Project URL

https://github.com/AnimatedLEDStrip/client-kotlin-mpp
Source Code Management

Source Code Management

https://github.com/AnimatedLEDStrip/client-kotlin-mpp

Download animatedledstrip-client

How to add to project

<!-- 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>
// https://jarcasting.com/artifacts/io.github.animatedledstrip/animatedledstrip-client/
implementation 'io.github.animatedledstrip:animatedledstrip-client:1.0.1'
// https://jarcasting.com/artifacts/io.github.animatedledstrip/animatedledstrip-client/
implementation ("io.github.animatedledstrip:animatedledstrip-client:1.0.1")
'io.github.animatedledstrip:animatedledstrip-client:jar:1.0.1'
<dependency org="io.github.animatedledstrip" name="animatedledstrip-client" rev="1.0.1">
  <artifact name="animatedledstrip-client" type="jar" />
</dependency>
@Grapes(
@Grab(group='io.github.animatedledstrip', module='animatedledstrip-client', version='1.0.1')
)
libraryDependencies += "io.github.animatedledstrip" % "animatedledstrip-client" % "1.0.1"
[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.

Build Status codecov Maven Central

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.

io.github.animatedledstrip

Versions

Version
1.0.1
0.7
0.6
0.5
0.4
0.3
0.3-alpha
0.2
0.1