Skip to content

tvidal-net/kpi

Repository files navigation

K-Pi

A kotlin native library for the raspberry-pi.

This project is in a very early development stage, but I'm uploading it to github, to help other people who are, like I was a few days ago, looking for a kotlin native lib for the raspberry-pi.

As of now, this library is just a wrapper around the C Library for the Broadcom BCM 2835, created by Mike McCauley.

Is has been tested on a raspberry-pi zero.

To build for the linuxArm32Hfp target, a linux development environment is needed. I am using Debian Buster Desktop Workstation to compile it.

Usage

Apart from the library's core module, I'm creating an executable module for each supported raspberry-pi feature.

GPIO is the only feature that doesn't require root. To work around this limitation, I usually set the suid as soon as the executable is uploaded to the raspberry pi.

Modules

GPIO

Example:

bash -x scripts/send_to_pi 'gpio' '192.168.0.xxx'

PWM

Example:

import uk.tvidal.kpi.bcm2835.PWM
import uk.tvidal.kpi.bcm2835.PWM.PWM_RANGE
import uk.tvidal.kpi.bcm2835.delay
import kotlin.time.ExperimentalTime

@ExperimentalTime
@ExperimentalUnsignedTypes
fun main() {
    // enabled the PWM interface
    // using default settings
    PWM.init()
    for (i in 0 until PWM_RANGE) {
        PWM(i)
        delay(2)
    }
}
scp -C 'pwm/build/bin/arm/debugExecutable/pwm.kexe' '[email protected]:~'
ssh '[email protected]' 'sudo bash -' <<EOF
chown root:pi 'pwm.kexe'
chmod 04775 'pwm.kexe'
./pwm.kexe
EOF

Road Map

  1. GPIO module
  2. Command-Line Argument Parser
  3. Support for SPI and I2C interfaces
  4. Alternative implementation wrapping the WiringPi lib
  5. Support the BCM 2836 and BCM 2837 chipsets through a common interface
  6. Better automated testing
  7. Benchmark comparison of multiple implementations

About

K-Pi: Kotlin Native on the Raspberry-Pi

Resources

License

Stars

Watchers

Forks

Packages

No packages published