Pi4K

KO | EN

gitlite — search

#python #hacktoberfest #typescript #llm #golang #android #linux #docker #macos #nodejs #security #openai #mcp #open-source

(★ 69)

Pi4J Kotlin bindings for the Raspberry Pi GPIO.

Pi4K Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Notice
This repo is for Pi4J V1 and is **no longer maintained**. The **project is now maintained** at [Pi4J/pi4j-kotlin](https://github.com/Pi4J/pi4j-kotlin) instead

# Pi4K
[Pi4J](https://www.pi4j.com) Kotlin bindings.  
[![Awesome Kotlin Badge](https://kotlin.link/awesome-kotlin.svg)](https://github.com/KotlinBy/awesome-kotlin)
[![](https://jitpack.io/v/mhashim6/Pi4K.svg)](https://jitpack.io/#mhashim6/Pi4K)

## Demo
Make sure to check [Examples.kt](https://github.com/mhashim6/Pi4K/blob/master/src/main/kotlin/mhashim6/pi4k/Examples.kt).

```kotlin
fun blink() = digitalOutput(GPIO_01) {
    while (true) {
        toggle()
        delay(500)
    }
}
```
- Pulse:
```kotlin
digitalOutput(GPIO_01).pulse(600)
```

- Triggers:
```kotlin
val input = digitalInput(GPIO_04)
val output = digitalOutput(GPIO_05)
input.trigger(output) //output is HIGH when input is HIGH.
// input.trigger(output, whenState = PinState.LOW, targetState = PinState.HIGH) //output is HIGH when input is LOW.
```

- Pulse triggers:
```kotlin
val input = digitalInput(GPIO_04)
val output = digitalOutput(GPIO_05)
input.triggerPulse(output, PinState.HIGH, millis = 1000) //when input is HIGH, output is HIGH for 1 second
```

- State change listeners:
```kotlin
digitalInput(GPIO_06).onStateChange { event, edge, state -> println(state) }
```

- PWM
```kotlin
pwm(clockDivisor = 500, mode = PWM_MODE_MS, range = 1000)
pwmOutput(GPIO_01, 400)
```
- Software PWM
```kotlin
softPwmOutput(GPIO_01, 400)
```
- Analog counterparts are also available.

- When done with gpio, housekeeping is necessary;

```kotlin
gpioShutdown()
```

## Testing
Tests were simulated on my machine using the ` PI4J_PLATFORM=Simulated` Environment variable.  
However, I was not able to mock/test `AnalogPins` bindings. Contributions are always welcome.

## Dependency
- Gradle

Add it in your root build.gradle at the end of repositories:

```groovy
allprojects {
    repositories {
        ...
        maven { url 'https://jitpack.io' }
    }
}
```
Add the dependency:
```groovy
dependencies {
    implementation 'com.github.mhashim6:Pi4K:0.1'
}
```
---
- Maven
```xml
<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>
```
Add the dependency:
```xml
<dependency>
    <groupId>com.github.mhashim6</groupId>
    <artifactId>Pi4K</artifactId>
    <version>0.1</version>
</dependency>
```

Pi4K

Pi4K Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Pi4K

Pi4K Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README