diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a7cee95 --- /dev/null +++ b/.gitignore @@ -0,0 +1,15 @@ +*.iml +.gradle +/local.properties +.idea +/.idea/caches +/.idea/libraries +/.idea/modules.xml +/.idea/workspace.xml +/.idea/navEditor.xml +/.idea/assetWizardSettings.xml +.DS_Store +/build +/captures +.externalNativeBuild +.cxx diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..d4ed315 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2020 Wideverse + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..fa7e522 --- /dev/null +++ b/README.md @@ -0,0 +1,148 @@ +# KThings +## Kotlin friendly GPIO support on Andorid + +![](https://github.com/paolorotolo/kthings/blob/master/images/kthings.gif) +```kotlin +suspend fun blinkLed() { + with (kthings) { + while (true) { + pinUp(led) + delay(1000) + pinDown(led) + delay(1000) + } + } +} +``` + +## What +KThings is a Kotlin library that aims to create a comfortable interface to manage GPIO on Android. It's still an early stage project that supports for now, generic GPIO pins, RGB Leds and Buttons. ***Root is required for this library to work.*** + +### Coroutines +Each function that operates on hardware is `suspend`. In this way, you can compose more complex instruction like make a led blink after some delay easily. Also, events from GPIO are exposed as Kotlin's `flow`. + +# Library Usage +1. **Add the JitPack repository to your build file** + + Add it in your root build.gradle at the end of repositories: +```gradle +allprojects { + repositories { + ... + maven { url 'https://jitpack.io' } + } +} +``` + +2. **Add the dependency** + +```gradle +dependencies { + implementation 'com.github.wideverse:kthings:1.0.0' +} +``` + +3. **Initialize the library** + +```kotlin +val kthings = Kthings() +``` +## Generic GPIO PIN +First create a new generic pin: +```kotlin +const val PIN = 42 +val led = GpioPin(PIN) +``` + +You may also set `direction` and `reverse` parameters that corrisponds to Linux `active_low` and `direction` [values for GPIO](https://www.kernel.org/doc/Documentation/gpio/sysfs.txt). +```kotlin +val pin = GpioPin(LED_PIN, + direction = PinDirection.OUTPUT, + isReversed = true) +``` + +The first time before using the pin, you need to init it (equals to Linux's `export`): +```kotlin +kthings.initPin(led) +``` + +Then, it's possible to set the pin Up and Down with `pinUp(led)` and `pinDown(led)`. +Both functions are suspend. For example, this makes a led blink: +```kotlin +suspend fun blinkLed() { + with (kthings) { + while (true) { + pinUp(led) + delay(1000) + pinDown(led) + delay(1000) + } + } +} +``` + +## RGB +RGB constructor takes 3 different integers for each PIN: +```kotlin + val rgbLed = GpioRgb(PIN_RED, PIN_GREEN, PIN_BLUE) + kthings.initRgb(rgbLed) +``` +Alternatively, you can pass 3 GpioPin objects each one with its attributes as explained above. +Since the majority of RGB leds have inverted values for High/Low, the parameter `isReverse` is `true` by default. + +The state of an RGB can be updated with `kthings.setRgbState(rgb)` method. You can manipulate the state of each color using `rgb.set()`: +```kotlin +// Activate RED and BLUE pin +suspend fun rgbRedAndBlue() { + with(kthings) { + setRgbState( + rgbLed.set( + red = PinState.UP, + green = PinState.DOWN, + blue = PinState.UP) + )} +} +``` +`rgb.setOnly` can be used to set only one value UP while keeping the others DOWN. +```kotlin +// Activate only RED pin +suspend fun rgbRed() { + with (kthings) { + setRgbState(rgbLed.setOnly(red = PinState.UP)) + } +} + +// Blink with each RGB color each 5 seconds +suspend fun redThenGreenThenBlue() { + with (kthings) { + setRgbState(rgbLed.setOnly(red = PinState.UP)) + delay(5000) + setRgbState(rgbLed.setOnly(green = PinState.UP)) + delay(5000) + setRgbState(rgbLed.setOnly(blue = PinState.UP)) + } +} +``` + +## Button +Init a new button with: +```kotlin +val button = GpioButton(BUTTON_PIN, 1000) +kthings.initButton(button) +``` +The second parameter is the flow emission frequency in milliseconds. `initButton` will take care of all the pin settings. Alternativly, you can construct a new GpioButton passing a GpioPin with its direction set to `direction.INPUT`. + +Observe button state changes: +```kotlin +suspend fun observeButton() { + kthings.observeButton(button).collect { + when (it) { + PinState.UP -> log("Button is pressed") + PinState.DOWN -> log("Button is released") + } + } +} +``` + +## About +This library has been developed at [Wideverse](https://www.wideverse.com/it/home-it/) @ [Polytechnic University of Bari](https://www.poliba.it/). diff --git a/app/.gitignore b/app/.gitignore new file mode 100644 index 0000000..796b96d --- /dev/null +++ b/app/.gitignore @@ -0,0 +1 @@ +/build diff --git a/app/build.gradle b/app/build.gradle new file mode 100644 index 0000000..956ee0e --- /dev/null +++ b/app/build.gradle @@ -0,0 +1,63 @@ +/* + * Copyright (c) 2020 Wideverse + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +apply plugin: 'com.android.application' +apply plugin: 'kotlin-android' +apply plugin: 'kotlin-android-extensions' + +android { + compileSdkVersion 29 + buildToolsVersion "29.0.2" + + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + + defaultConfig { + applicationId "com.wideverse.kthings.example" + minSdkVersion 21 + targetSdkVersion 29 + versionCode 1 + versionName "1.0" + + testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" + } + + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + } + +} + +dependencies { + implementation fileTree(dir: 'libs', include: ['*.jar']) + implementation project(path: ':kthings') + + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" + implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.3' + implementation 'androidx.lifecycle:lifecycle-runtime-ktx:2.2.0' + + implementation 'androidx.appcompat:appcompat:1.1.0' + implementation 'androidx.core:core-ktx:1.2.0' + implementation 'androidx.constraintlayout:constraintlayout:1.1.3' + testImplementation 'junit:junit:4.12' + androidTestImplementation 'androidx.test.ext:junit:1.1.1' + androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0' +} diff --git a/app/proguard-rules.pro b/app/proguard-rules.pro new file mode 100644 index 0000000..f1b4245 --- /dev/null +++ b/app/proguard-rules.pro @@ -0,0 +1,21 @@ +# Add project specific ProGuard rules here. +# You can control the set of applied configuration files using the +# proguardFiles setting in build.gradle. +# +# For more details, see +# http://developer.android.com/guide/developing/tools/proguard.html + +# If your project uses WebView with JS, uncomment the following +# and specify the fully qualified class name to the JavaScript interface +# class: +#-keepclassmembers class fqcn.of.javascript.interface.for.webview { +# public *; +#} + +# Uncomment this to preserve the line number information for +# debugging stack traces. +#-keepattributes SourceFile,LineNumberTable + +# If you keep the line number information, uncomment this to +# hide the original source file name. +#-renamesourcefileattribute SourceFile diff --git a/app/src/androidTest/java/com/wideverse/kthings/example/ExampleInstrumentedTest.kt b/app/src/androidTest/java/com/wideverse/kthings/example/ExampleInstrumentedTest.kt new file mode 100644 index 0000000..2e1fdbb --- /dev/null +++ b/app/src/androidTest/java/com/wideverse/kthings/example/ExampleInstrumentedTest.kt @@ -0,0 +1,24 @@ +package com.wideverse.kthings.example + +import androidx.test.platform.app.InstrumentationRegistry +import androidx.test.ext.junit.runners.AndroidJUnit4 + +import org.junit.Test +import org.junit.runner.RunWith + +import org.junit.Assert.* + +/** + * Instrumented test, which will execute on an Android device. + * + * See [testing documentation](http://d.android.com/tools/testing). + */ +@RunWith(AndroidJUnit4::class) +class ExampleInstrumentedTest { + @Test + fun useAppContext() { + // Context of the app under test. + val appContext = InstrumentationRegistry.getInstrumentation().targetContext + assertEquals("com.wideverse.kthings.example", appContext.packageName) + } +} diff --git a/app/src/main/AndroidManifest.xml b/app/src/main/AndroidManifest.xml new file mode 100644 index 0000000..d53545c --- /dev/null +++ b/app/src/main/AndroidManifest.xml @@ -0,0 +1,21 @@ + + + + + + + + + + + + + + \ No newline at end of file diff --git a/app/src/main/java/com/wideverse/kthings/example/MainActivity.kt b/app/src/main/java/com/wideverse/kthings/example/MainActivity.kt new file mode 100644 index 0000000..b051a52 --- /dev/null +++ b/app/src/main/java/com/wideverse/kthings/example/MainActivity.kt @@ -0,0 +1,96 @@ +package com.wideverse.kthings.example + +import androidx.appcompat.app.AppCompatActivity +import android.os.Bundle +import android.util.Log +import androidx.lifecycle.lifecycleScope +import com.wideverse.kthings.* +import kotlinx.coroutines.Dispatchers +import kotlinx.coroutines.delay +import kotlinx.coroutines.flow.collect +import kotlinx.coroutines.launch + +const val LED_PIN = 1 +const val BUTTON_PIN = 2 + +const val RGB_PIN_RED = 3 +const val RGB_PIN_GREEN = 4 +const val RGB_PIN_BLUE = 5 + + +class MainActivity : AppCompatActivity() { + + private val kthings = Kthings() + + private val led = GpioPin(LED_PIN) + + private val rgbLed = GpioRgb(RGB_PIN_RED, RGB_PIN_GREEN, RGB_PIN_BLUE) + private val button = GpioButton(BUTTON_PIN, 1000) + + override fun onCreate(savedInstanceState: Bundle?) { + super.onCreate(savedInstanceState) + setContentView(R.layout.activity_main) + + lifecycleScope.launch(Dispatchers.IO) { + initPins() + + observeButton() + blinkLed() + } + } + + private suspend fun initPins() { + with(kthings) { + initRgb(rgbLed) + initButton(button) + initPin(led) + } + } + + private suspend fun blinkLed() { + with (kthings) { + while (true) { + pinUp(led) + delay(1000) + pinDown(led) + delay(1000) + } + } + } + + private suspend fun rgbRedAndBlue() { + with(kthings) { + setRgbState( + rgbLed.set( + red = PinState.UP, + green = PinState.DOWN, + blue = PinState.UP) + ) + } + } + + private suspend fun rgbRedThenGreenThenBlue() { + with (kthings) { + setRgbState(rgbLed.setOnly(red = PinState.UP)) + delay(5000) + setRgbState(rgbLed.setOnly(green = PinState.UP)) + delay(5000) + setRgbState(rgbLed.setOnly(blue = PinState.UP)) + } + } + + private suspend fun rgbRed() { + kthings.setRgbState( + rgbLed.setOnly(red = PinState.UP) + ) + } + + private suspend fun observeButton() { + kthings.observeButton(button).collect { + when (it) { + PinState.UP -> Log.d("kthings", "Button is pressed") + PinState.DOWN -> Log.d("kthings", "Button is released") + } + } + } +} diff --git a/app/src/main/res/drawable-v24/ic_launcher_foreground.xml b/app/src/main/res/drawable-v24/ic_launcher_foreground.xml new file mode 100644 index 0000000..2b068d1 --- /dev/null +++ b/app/src/main/res/drawable-v24/ic_launcher_foreground.xml @@ -0,0 +1,30 @@ + + + + + + + + + + + \ No newline at end of file diff --git a/app/src/main/res/drawable/ic_launcher_background.xml b/app/src/main/res/drawable/ic_launcher_background.xml new file mode 100644 index 0000000..07d5da9 --- /dev/null +++ b/app/src/main/res/drawable/ic_launcher_background.xml @@ -0,0 +1,170 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/app/src/main/res/layout/activity_main.xml b/app/src/main/res/layout/activity_main.xml new file mode 100644 index 0000000..4fc2444 --- /dev/null +++ b/app/src/main/res/layout/activity_main.xml @@ -0,0 +1,18 @@ + + + + + + \ No newline at end of file diff --git a/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml b/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml new file mode 100644 index 0000000..eca70cf --- /dev/null +++ b/app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml b/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml new file mode 100644 index 0000000..eca70cf --- /dev/null +++ b/app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml @@ -0,0 +1,5 @@ + + + + + \ No newline at end of file diff --git a/app/src/main/res/mipmap-hdpi/ic_launcher.png b/app/src/main/res/mipmap-hdpi/ic_launcher.png new file mode 100644 index 0000000..a571e60 Binary files /dev/null and b/app/src/main/res/mipmap-hdpi/ic_launcher.png differ diff --git a/app/src/main/res/mipmap-hdpi/ic_launcher_round.png b/app/src/main/res/mipmap-hdpi/ic_launcher_round.png new file mode 100644 index 0000000..61da551 Binary files /dev/null and b/app/src/main/res/mipmap-hdpi/ic_launcher_round.png differ diff --git a/app/src/main/res/mipmap-mdpi/ic_launcher.png b/app/src/main/res/mipmap-mdpi/ic_launcher.png new file mode 100644 index 0000000..c41dd28 Binary files /dev/null and b/app/src/main/res/mipmap-mdpi/ic_launcher.png differ diff --git a/app/src/main/res/mipmap-mdpi/ic_launcher_round.png b/app/src/main/res/mipmap-mdpi/ic_launcher_round.png new file mode 100644 index 0000000..db5080a Binary files /dev/null and b/app/src/main/res/mipmap-mdpi/ic_launcher_round.png differ diff --git a/app/src/main/res/mipmap-xhdpi/ic_launcher.png b/app/src/main/res/mipmap-xhdpi/ic_launcher.png new file mode 100644 index 0000000..6dba46d Binary files /dev/null and b/app/src/main/res/mipmap-xhdpi/ic_launcher.png differ diff --git a/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png b/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png new file mode 100644 index 0000000..da31a87 Binary files /dev/null and b/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png differ diff --git a/app/src/main/res/mipmap-xxhdpi/ic_launcher.png b/app/src/main/res/mipmap-xxhdpi/ic_launcher.png new file mode 100644 index 0000000..15ac681 Binary files /dev/null and b/app/src/main/res/mipmap-xxhdpi/ic_launcher.png differ diff --git a/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png b/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png new file mode 100644 index 0000000..b216f2d Binary files /dev/null and b/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png differ diff --git a/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png b/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png new file mode 100644 index 0000000..f25a419 Binary files /dev/null and b/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png differ diff --git a/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png b/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png new file mode 100644 index 0000000..e96783c Binary files /dev/null and b/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png differ diff --git a/app/src/main/res/values/colors.xml b/app/src/main/res/values/colors.xml new file mode 100644 index 0000000..030098f --- /dev/null +++ b/app/src/main/res/values/colors.xml @@ -0,0 +1,6 @@ + + + #6200EE + #3700B3 + #03DAC5 + diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml new file mode 100644 index 0000000..82abe4d --- /dev/null +++ b/app/src/main/res/values/strings.xml @@ -0,0 +1,3 @@ + + KThings + diff --git a/app/src/main/res/values/styles.xml b/app/src/main/res/values/styles.xml new file mode 100644 index 0000000..5885930 --- /dev/null +++ b/app/src/main/res/values/styles.xml @@ -0,0 +1,11 @@ + + + + + + diff --git a/app/src/test/java/com/wideverse/kthings/example/ExampleUnitTest.kt b/app/src/test/java/com/wideverse/kthings/example/ExampleUnitTest.kt new file mode 100644 index 0000000..f8bfb7e --- /dev/null +++ b/app/src/test/java/com/wideverse/kthings/example/ExampleUnitTest.kt @@ -0,0 +1,17 @@ +package com.wideverse.kthings.example + +import org.junit.Test + +import org.junit.Assert.* + +/** + * Example local unit test, which will execute on the development machine (host). + * + * See [testing documentation](http://d.android.com/tools/testing). + */ +class ExampleUnitTest { + @Test + fun addition_isCorrect() { + assertEquals(4, 2 + 2) + } +} diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..3a38f34 --- /dev/null +++ b/build.gradle @@ -0,0 +1,30 @@ +// Top-level build file where you can add configuration options common to all sub-projects/modules. + +buildscript { + ext.kotlin_version = '1.3.61' + repositories { + google() + jcenter() + + } + dependencies { + classpath 'com.android.tools.build:gradle:3.6.0-rc03' + classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" + + // NOTE: Do not place your application dependencies here; they belong + // in the individual module build.gradle files + } +} + +allprojects { + repositories { + google() + jcenter() + maven { url 'https://jitpack.io' } + + } +} + +task clean(type: Delete) { + delete rootProject.buildDir +} diff --git a/gradle.properties b/gradle.properties new file mode 100644 index 0000000..23339e0 --- /dev/null +++ b/gradle.properties @@ -0,0 +1,21 @@ +# Project-wide Gradle settings. +# IDE (e.g. Android Studio) users: +# Gradle settings configured through the IDE *will override* +# any settings specified in this file. +# For more details on how to configure your build environment visit +# http://www.gradle.org/docs/current/userguide/build_environment.html +# Specifies the JVM arguments used for the daemon process. +# The setting is particularly useful for tweaking memory settings. +org.gradle.jvmargs=-Xmx1536m +# When configured, Gradle will run in incubating parallel mode. +# This option should only be used with decoupled projects. More details, visit +# http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects +# org.gradle.parallel=true +# AndroidX package structure to make it clearer which packages are bundled with the +# Android operating system, and which are packaged with your app's APK +# https://developer.android.com/topic/libraries/support-library/androidx-rn +android.useAndroidX=true +# Automatically convert third-party libraries to use AndroidX +android.enableJetifier=true +# Kotlin code style for this project: "official" or "obsolete": +kotlin.code.style=official diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar new file mode 100644 index 0000000..f6b961f Binary files /dev/null and b/gradle/wrapper/gradle-wrapper.jar differ diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties new file mode 100644 index 0000000..3f878c6 --- /dev/null +++ b/gradle/wrapper/gradle-wrapper.properties @@ -0,0 +1,6 @@ +#Thu Feb 13 20:35:42 CET 2020 +distributionBase=GRADLE_USER_HOME +distributionPath=wrapper/dists +zipStoreBase=GRADLE_USER_HOME +zipStorePath=wrapper/dists +distributionUrl=https\://services.gradle.org/distributions/gradle-5.6.4-all.zip diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..cccdd3d --- /dev/null +++ b/gradlew @@ -0,0 +1,172 @@ +#!/usr/bin/env sh + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS="" + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin, switch paths to Windows format before running java +if $cygwin ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=$((i+1)) + done + case $i in + (0) set -- ;; + (1) set -- "$args0" ;; + (2) set -- "$args0" "$args1" ;; + (3) set -- "$args0" "$args1" "$args2" ;; + (4) set -- "$args0" "$args1" "$args2" "$args3" ;; + (5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + (6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + (7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + (8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + (9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=$(save "$@") + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +# by default we should be in the correct project dir, but when run from Finder on Mac, the cwd is wrong +if [ "$(uname)" = "Darwin" ] && [ "$HOME" = "$PWD" ]; then + cd "$(dirname "$0")" +fi + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..e95643d --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,84 @@ +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS= + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto init + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto init + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:init +@rem Get command-line arguments, handling Windows variants + +if not "%OS%" == "Windows_NT" goto win9xME_args + +:win9xME_args +@rem Slurp the command line arguments. +set CMD_LINE_ARGS= +set _SKIP=2 + +:win9xME_args_slurp +if "x%~1" == "x" goto execute + +set CMD_LINE_ARGS=%* + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS% + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/images/kthings.gif b/images/kthings.gif new file mode 100644 index 0000000..7af05c6 Binary files /dev/null and b/images/kthings.gif differ diff --git a/kthings/.gitignore b/kthings/.gitignore new file mode 100644 index 0000000..796b96d --- /dev/null +++ b/kthings/.gitignore @@ -0,0 +1 @@ +/build diff --git a/kthings/build.gradle b/kthings/build.gradle new file mode 100644 index 0000000..1c15407 --- /dev/null +++ b/kthings/build.gradle @@ -0,0 +1,62 @@ +/* + * Copyright (c) 2020 Wideverse + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +apply plugin: 'com.android.library' +apply plugin: 'kotlin-android' +apply plugin: 'kotlin-android-extensions' + +android { + compileSdkVersion 29 + buildToolsVersion "29.0.2" + + compileOptions { + sourceCompatibility JavaVersion.VERSION_1_8 + targetCompatibility JavaVersion.VERSION_1_8 + } + + defaultConfig { + minSdkVersion 21 + targetSdkVersion 29 + versionCode 1 + versionName "1.0" + + testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" + consumerProguardFiles 'consumer-rules.pro' + } + + buildTypes { + release { + minifyEnabled false + proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' + } + } + +} + +dependencies { + implementation fileTree(dir: 'libs', include: ['*.jar']) + implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version" + implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.3.3" + + implementation 'androidx.appcompat:appcompat:1.1.0' + implementation 'androidx.core:core-ktx:1.2.0' + + implementation 'com.github.topjohnwu.libsu:core:2.5.1' + + testImplementation 'junit:junit:4.12' + androidTestImplementation 'androidx.test.ext:junit:1.1.1' + androidTestImplementation 'androidx.test.espresso:espresso-core:3.2.0' +} diff --git a/kthings/consumer-rules.pro b/kthings/consumer-rules.pro new file mode 100644 index 0000000..e69de29 diff --git a/kthings/proguard-rules.pro b/kthings/proguard-rules.pro new file mode 100644 index 0000000..f1b4245 --- /dev/null +++ b/kthings/proguard-rules.pro @@ -0,0 +1,21 @@ +# Add project specific ProGuard rules here. +# You can control the set of applied configuration files using the +# proguardFiles setting in build.gradle. +# +# For more details, see +# http://developer.android.com/guide/developing/tools/proguard.html + +# If your project uses WebView with JS, uncomment the following +# and specify the fully qualified class name to the JavaScript interface +# class: +#-keepclassmembers class fqcn.of.javascript.interface.for.webview { +# public *; +#} + +# Uncomment this to preserve the line number information for +# debugging stack traces. +#-keepattributes SourceFile,LineNumberTable + +# If you keep the line number information, uncomment this to +# hide the original source file name. +#-renamesourcefileattribute SourceFile diff --git a/kthings/src/androidTest/java/com/wideverse/kthings/ExampleInstrumentedTest.kt b/kthings/src/androidTest/java/com/wideverse/kthings/ExampleInstrumentedTest.kt new file mode 100644 index 0000000..48938ce --- /dev/null +++ b/kthings/src/androidTest/java/com/wideverse/kthings/ExampleInstrumentedTest.kt @@ -0,0 +1,40 @@ +/* + * Copyright (c) 2020 Wideverse + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.wideverse.kthings + +import androidx.test.platform.app.InstrumentationRegistry +import androidx.test.ext.junit.runners.AndroidJUnit4 + +import org.junit.Test +import org.junit.runner.RunWith + +import org.junit.Assert.* + +/** + * Instrumented test, which will execute on an Android device. + * + * See [testing documentation](http://d.android.com/tools/testing). + */ +@RunWith(AndroidJUnit4::class) +class ExampleInstrumentedTest { + @Test + fun useAppContext() { + // Context of the app under test. + val appContext = InstrumentationRegistry.getInstrumentation().targetContext + assertEquals("com.wideverse.kthings.test", appContext.packageName) + } +} diff --git a/kthings/src/main/AndroidManifest.xml b/kthings/src/main/AndroidManifest.xml new file mode 100644 index 0000000..ff9580b --- /dev/null +++ b/kthings/src/main/AndroidManifest.xml @@ -0,0 +1,18 @@ + + + diff --git a/kthings/src/main/java/com/wideverse/kthings/GpioButton.kt b/kthings/src/main/java/com/wideverse/kthings/GpioButton.kt new file mode 100644 index 0000000..0603537 --- /dev/null +++ b/kthings/src/main/java/com/wideverse/kthings/GpioButton.kt @@ -0,0 +1,26 @@ +/* + * Copyright (c) 2020 Wideverse + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.wideverse.kthings + +private const val DEFAULT_UPDATE_FREQUENCY = 500L +data class GpioButton( + val pin: GpioPin, + val updateFrequency: Long = DEFAULT_UPDATE_FREQUENCY){ + + constructor(pinNumber: Int, frequency: Long = DEFAULT_UPDATE_FREQUENCY): + this(GpioPin(number = pinNumber, direction = PinDirection.INPUT), frequency) +} \ No newline at end of file diff --git a/kthings/src/main/java/com/wideverse/kthings/GpioPin.kt b/kthings/src/main/java/com/wideverse/kthings/GpioPin.kt new file mode 100644 index 0000000..494b0c4 --- /dev/null +++ b/kthings/src/main/java/com/wideverse/kthings/GpioPin.kt @@ -0,0 +1,24 @@ +/* + * Copyright (c) 2020 Wideverse + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.wideverse.kthings + +data class GpioPin( + val number: Int, + var state: PinState = PinState.DOWN, + var direction: PinDirection = PinDirection.OUTPUT, + var isReversed: Boolean = false +) \ No newline at end of file diff --git a/kthings/src/main/java/com/wideverse/kthings/GpioRgb.kt b/kthings/src/main/java/com/wideverse/kthings/GpioRgb.kt new file mode 100644 index 0000000..6ebc7d0 --- /dev/null +++ b/kthings/src/main/java/com/wideverse/kthings/GpioRgb.kt @@ -0,0 +1,66 @@ +/* + * Copyright (c) 2020 Wideverse + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.wideverse.kthings + +data class GpioRgb( + var redPin: GpioPin, + val greenPin: GpioPin, + val bluePin: GpioPin, + val isReverse: Boolean = true) { + + constructor(redPin: Int, greenPin: Int, bluePin: Int): this( + GpioPin(number = redPin, direction = PinDirection.OUTPUT), + GpioPin(number = greenPin, direction = PinDirection.OUTPUT), + GpioPin(number = bluePin, direction = PinDirection.OUTPUT) + ) + + init { + if (isReverse) { + getPins().forEach { it.isReversed = true } + } + } + + fun set(red: PinState? = null, green: PinState? = null, blue: PinState? = null): GpioRgb { + red?.let { redPin.state = red } + green?.let { greenPin.state = green } + blue?.let { bluePin.state = blue } + + return this + } + + fun setOnly( + red: PinState = PinState.DOWN, + green: PinState = PinState.DOWN, + blue: PinState = PinState.DOWN): GpioRgb { + redPin.state = red + greenPin.state = green + bluePin.state = blue + + return this + } + + fun setOff(): GpioRgb { + redPin.state = PinState.DOWN + greenPin.state = PinState.DOWN + bluePin.state = PinState.DOWN + + return this + } + + fun getPins() = listOf(redPin, greenPin, bluePin) + fun getPinNumbers() = listOf(redPin.number, greenPin.number, bluePin.number) +} \ No newline at end of file diff --git a/kthings/src/main/java/com/wideverse/kthings/GpioUtils.kt b/kthings/src/main/java/com/wideverse/kthings/GpioUtils.kt new file mode 100644 index 0000000..f4a62ac --- /dev/null +++ b/kthings/src/main/java/com/wideverse/kthings/GpioUtils.kt @@ -0,0 +1,26 @@ +/* + * Copyright (c) 2020 Wideverse + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.wideverse.kthings + +import java.io.File + +object GpioUtiles { + fun readFromFile(path: String): String { + val file = File(path) + return file.readText() + } +} \ No newline at end of file diff --git a/kthings/src/main/java/com/wideverse/kthings/Kthings.kt b/kthings/src/main/java/com/wideverse/kthings/Kthings.kt new file mode 100644 index 0000000..175f6ac --- /dev/null +++ b/kthings/src/main/java/com/wideverse/kthings/Kthings.kt @@ -0,0 +1,159 @@ +/* + * Copyright (c) 2020 Wideverse + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.wideverse.kthings + +import android.util.Log +import com.topjohnwu.superuser.Shell +import kotlinx.coroutines.ExperimentalCoroutinesApi +import kotlinx.coroutines.delay +import kotlinx.coroutines.flow.callbackFlow +import kotlinx.coroutines.suspendCancellableCoroutine +import java.io.File +import kotlin.coroutines.resume + +enum class PinDirection { INPUT, OUTPUT } +enum class PinState {UP, DOWN} + +const val GPIO_SYS_PATH = "/sys/class/gpio" + +class Kthings { + private val gpioState = HashMap() + + // === BUTTON === + suspend fun initButton(button: GpioButton) { + initPin(button.pin) + } + + @ExperimentalCoroutinesApi + fun observeButton(button: GpioButton) = callbackFlow { + while(true) { + try { + val value = File(pinValuePath(button.pin.number)).readText().trim() + val output = if (value == "1") PinState.UP else PinState.DOWN + + offer(output) + delay(button.updateFrequency) + } catch (e: Exception) { + Log.e("hub", e.localizedMessage) + } + } + } + + // === RGB === + suspend fun setRgbState(gpioRgb: GpioRgb){ + gpioRgb.getPins().forEach { pin -> + val number = pin.number + var state = pin.state + + when (state){ + PinState.UP -> pinUp(number) + PinState.DOWN -> pinDown(number) + } + } + } + + suspend fun initRgb(vararg gpioRgb: GpioRgb) { + gpioRgb.forEach { + it.getPins().forEach { initPin(it) } + } + } + + + // === PIN === + suspend fun initPin(vararg pin: GpioPin) { + pin.forEach { + exportPin(it.number) + setPinDir(it.direction, it.number) + pinReverse(it.number, it.isReversed) + gpioState[it.number] = it + } + } + + suspend fun pinUp(pin: GpioPin){ + pinUp(pin.number) + } + + suspend fun pinDown(pin: GpioPin){ + pinDown(pin.number) + } + + private suspend fun setPinDir(direction: PinDirection, vararg pin: Int) { + val dir = if (direction == PinDirection.INPUT) "in" else { "out" } + + pin.forEach { runAsRoot(pinDirCommand(it, dir)) } + } + + suspend fun pinReverse(pin: Int, reverse: Boolean) { + val value = if (reverse) 1 else 0 + runAsRoot(pinActiveLow(pin, value)) + } + + private suspend fun pinUp(vararg pin: Int) { + pin.forEach { + runAsRoot(pinHighCommand(it)) + gpioState[it]?.state = PinState.UP + } + } + + private suspend fun pinDown(vararg pin: Int) { + pin.forEach { + runAsRoot(pinLowCommand(it)) + gpioState[it]?.state = PinState.DOWN + } + } + + private suspend fun exportPin(vararg pin: Int) { + pin.forEach { + runAsRoot(exportCommand(it)) + } + } + + private suspend fun unexportPin(vararg pin: Int) { + pin.forEach { + runAsRoot(unexportCommand(it)) + } + } + + suspend fun releasePin(vararg pin: Int) { + pin.forEach { + unexportPin(it) + gpioState.remove(it) + } + } + + suspend fun releaseAll() { + for ((pin, state) in gpioState) { + releasePin(pin) + } + } + + // === SHELL === + private suspend fun runAsRoot(vararg input: String): MutableList = suspendCancellableCoroutine { + // LOG PURPOSES + Shell.su(*input).submit { result -> + it.resume(result.out) + } + } + + private fun pinHighCommand(pin: Int) = "echo 1 > $GPIO_SYS_PATH/gpio$pin/value" + private fun pinLowCommand(pin: Int) = "echo 0 > $GPIO_SYS_PATH/gpio$pin/value" + private fun exportCommand(pin: Int) = "echo $pin > $GPIO_SYS_PATH/export" + private fun unexportCommand(pin: Int) = "echo $pin > $GPIO_SYS_PATH/unexport" + private fun pinDirCommand(pin: Int, dir: String) = "echo $dir > $GPIO_SYS_PATH/gpio$pin/direction" + private fun pinActiveLow(pin: Int, value: Int) = "echo $value > $GPIO_SYS_PATH/gpio$pin/active_low" + private fun pinValuePath(pin: Int) = "$GPIO_SYS_PATH/gpio$pin/value/" +} \ No newline at end of file diff --git a/kthings/src/test/java/com/wideverse/kthings/ExampleUnitTest.kt b/kthings/src/test/java/com/wideverse/kthings/ExampleUnitTest.kt new file mode 100644 index 0000000..ccf560f --- /dev/null +++ b/kthings/src/test/java/com/wideverse/kthings/ExampleUnitTest.kt @@ -0,0 +1,33 @@ +/* + * Copyright (c) 2020 Wideverse + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package com.wideverse.kthings + +import org.junit.Test + +import org.junit.Assert.* + +/** + * Example local unit test, which will execute on the development machine (host). + * + * See [testing documentation](http://d.android.com/tools/testing). + */ +class ExampleUnitTest { + @Test + fun addition_isCorrect() { + assertEquals(4, 2 + 2) + } +} diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..f06eb58 --- /dev/null +++ b/settings.gradle @@ -0,0 +1,3 @@ +rootProject.name='KThings' +include ':app' +include ':kthings'