├── app ├── .gitignore ├── src │ └── main │ │ ├── ic_launcher-playstore.png │ │ ├── res │ │ ├── mipmap-hdpi │ │ │ ├── ic_launcher.png │ │ │ ├── ic_launcher_round.png │ │ │ ├── ic_launcher_background.png │ │ │ └── ic_launcher_foreground.png │ │ ├── mipmap-mdpi │ │ │ ├── ic_launcher.png │ │ │ ├── ic_launcher_round.png │ │ │ ├── ic_launcher_background.png │ │ │ └── ic_launcher_foreground.png │ │ ├── mipmap-xhdpi │ │ │ ├── ic_banner.png │ │ │ ├── ic_launcher.png │ │ │ ├── ic_launcher_round.png │ │ │ ├── ic_banner_background.png │ │ │ ├── ic_banner_foreground.png │ │ │ ├── ic_launcher_background.png │ │ │ └── ic_launcher_foreground.png │ │ ├── mipmap-xxhdpi │ │ │ ├── ic_launcher.png │ │ │ ├── ic_launcher_round.png │ │ │ ├── ic_launcher_background.png │ │ │ └── ic_launcher_foreground.png │ │ ├── mipmap-xxxhdpi │ │ │ ├── ic_launcher.png │ │ │ ├── ic_launcher_round.png │ │ │ ├── ic_launcher_background.png │ │ │ └── ic_launcher_foreground.png │ │ ├── drawable-hdpi │ │ │ └── ic_notification.png │ │ ├── drawable-mdpi │ │ │ └── ic_notification.png │ │ ├── drawable-xhdpi │ │ │ └── ic_notification.png │ │ ├── drawable-xxhdpi │ │ │ └── ic_notification.png │ │ ├── drawable-xxxhdpi │ │ │ └── ic_notification.png │ │ ├── color │ │ │ ├── text_color.xml │ │ │ └── text_color_dark.xml │ │ ├── mipmap-anydpi-v26 │ │ │ ├── ic_banner.xml │ │ │ ├── ic_launcher.xml │ │ │ └── ic_launcher_round.xml │ │ ├── values │ │ │ ├── attrs.xml │ │ │ ├── colors.xml │ │ │ ├── themes.xml │ │ │ └── strings.xml │ │ ├── values-night │ │ │ └── themes.xml │ │ ├── xml │ │ │ └── usb_device_filter.xml │ │ └── layout │ │ │ └── activity_main.xml │ │ ├── java │ │ └── com │ │ │ └── clusterrr │ │ │ └── usbserialtelnetserver │ │ │ ├── BootCompletedReceiver.java │ │ │ ├── ConnectedReceiver.java │ │ │ ├── UsbSerialThread.java │ │ │ ├── TcpServerThread.java │ │ │ ├── TcpClientThread.java │ │ │ ├── UsbSerialTelnetService.java │ │ │ └── MainActivity.java │ │ └── AndroidManifest.xml ├── proguard-rules.pro └── build.gradle ├── fastlane └── metadata │ └── android │ └── en-US │ ├── short_description.txt │ ├── images │ ├── icon.png │ └── phoneScreenshots │ │ └── 01.jpg │ └── full_description.txt ├── .github ├── FUNDING.yml └── workflows │ └── android.yml ├── gradle └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── settings.gradle ├── gradle.properties ├── .gitignore ├── README.md ├── gradlew.bat ├── gradlew └── LICENSE /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /fastlane/metadata/android/en-US/short_description.txt: -------------------------------------------------------------------------------- 1 | binds a USB serial converter to a Telnet client -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: [ClusterM] 2 | custom: ["https://www.buymeacoffee.com/cluster", "https://boosty.to/cluster"] 3 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /app/src/main/ic_launcher-playstore.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/ic_launcher-playstore.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_banner.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xhdpi/ic_banner.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher.png -------------------------------------------------------------------------------- /fastlane/metadata/android/en-US/images/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/fastlane/metadata/android/en-US/images/icon.png -------------------------------------------------------------------------------- /app/src/main/res/drawable-hdpi/ic_notification.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/drawable-hdpi/ic_notification.png -------------------------------------------------------------------------------- /app/src/main/res/drawable-mdpi/ic_notification.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/drawable-mdpi/ic_notification.png -------------------------------------------------------------------------------- /app/src/main/res/drawable-xhdpi/ic_notification.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/drawable-xhdpi/ic_notification.png -------------------------------------------------------------------------------- /app/src/main/res/drawable-xxhdpi/ic_notification.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/drawable-xxhdpi/ic_notification.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/drawable-xxxhdpi/ic_notification.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/drawable-xxxhdpi/ic_notification.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_banner_background.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xhdpi/ic_banner_background.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_banner_foreground.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xhdpi/ic_banner_foreground.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_round.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_background.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_background.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-hdpi/ic_launcher_foreground.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-hdpi/ic_launcher_foreground.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher_background.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_background.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-mdpi/ic_launcher_foreground.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-mdpi/ic_launcher_foreground.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher_background.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_background.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xhdpi/ic_launcher_foreground.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xhdpi/ic_launcher_foreground.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher_background.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_background.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxhdpi/ic_launcher_foreground.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xxhdpi/ic_launcher_foreground.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher_background.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_background.png -------------------------------------------------------------------------------- /app/src/main/res/mipmap-xxxhdpi/ic_launcher_foreground.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/app/src/main/res/mipmap-xxxhdpi/ic_launcher_foreground.png -------------------------------------------------------------------------------- /fastlane/metadata/android/en-US/images/phoneScreenshots/01.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ClusterM/usb-serial-telnet-server/HEAD/fastlane/metadata/android/en-US/images/phoneScreenshots/01.jpg -------------------------------------------------------------------------------- /app/src/main/res/color/text_color.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /app/src/main/res/color/text_color_dark.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Fri May 27 11:38:17 MSK 2022 2 | distributionBase=GRADLE_USER_HOME 3 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip 4 | distributionPath=wrapper/dists 5 | zipStorePath=wrapper/dists 6 | zipStoreBase=GRADLE_USER_HOME 7 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_banner.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/main/res/values/attrs.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /app/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /settings.gradle: -------------------------------------------------------------------------------- 1 | pluginManagement { 2 | repositories { 3 | gradlePluginPortal() 4 | google() 5 | mavenCentral() 6 | } 7 | } 8 | dependencyResolutionManagement { 9 | repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS) 10 | repositories { 11 | google() 12 | mavenCentral() 13 | maven { url 'https://jitpack.io' } 14 | } 15 | } 16 | rootProject.name = "USB Serial Telnet Server" 17 | include ':app' 18 | -------------------------------------------------------------------------------- /app/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #FFBB86FC 4 | #FF6200EE 5 | #FF3700B3 6 | #B2EBF2 7 | #FF03DAC5 8 | #FF018786 9 | #FF000000 10 | #FFFFFFFF 11 | #FF0000FF 12 | #FF000080 13 | #FF303040 14 | #FFC0C0FF 15 | #FFF0F0F0 16 | -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /fastlane/metadata/android/en-US/full_description.txt: -------------------------------------------------------------------------------- 1 |

USB Serial Telnet Server is an Android app that binds a USB serial converter to a Telnet client. Just connect a USB serial adapter into USB OTG port of your Android device, start this app and connect to it using any Telnet client.

This method allows to use all console features like colors and special keys. So you can easyly control/install something like network devices with serial port using only your Android device.

This app uses usb-serial-for-android library by mik3y and supports USB to serial converter chips:

and devices implementing the CDC/ACM protocol like

-------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | } 4 | 5 | android { 6 | compileSdk 36 7 | 8 | defaultConfig { 9 | applicationId "com.clusterrr.usbserialtelnetserver" 10 | minSdk 21 11 | targetSdk 35 12 | versionCode 27 13 | versionName "2.0" 14 | } 15 | 16 | buildFeatures { 17 | buildConfig = true 18 | } 19 | 20 | buildTypes { 21 | release { 22 | minifyEnabled false 23 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 24 | } 25 | } 26 | 27 | compileOptions { 28 | sourceCompatibility JavaVersion.VERSION_17 29 | targetCompatibility JavaVersion.VERSION_17 30 | } 31 | namespace 'com.clusterrr.usbserialtelnetserver' 32 | 33 | applicationVariants.configureEach { variant -> 34 | variant.outputs.configureEach { output -> 35 | def formattedDate = new Date().format('yyMMdd-HHmmss') 36 | outputFileName = "UsbSerialTelnetServer-v${defaultConfig.versionCode}-${formattedDate}.apk" 37 | } 38 | } 39 | } 40 | 41 | dependencies { 42 | implementation 'com.google.android.material:material:1.12.0' 43 | implementation 'com.github.mik3y:usb-serial-for-android:3.9.0' 44 | implementation 'androidx.appcompat:appcompat:1.7.1' 45 | } 46 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | # Project-wide Gradle settings. 2 | # IDE (e.g. Android Studio) users: 3 | # Gradle settings configured through the IDE *will override* 4 | # any settings specified in this file. 5 | # For more details on how to configure your build environment visit 6 | # http://www.gradle.org/docs/current/userguide/build_environment.html 7 | # Specifies the JVM arguments used for the daemon process. 8 | # The setting is particularly useful for tweaking memory settings. 9 | org.gradle.jvmargs=-Xmx2048m -Dfile.encoding=UTF-8 10 | # When configured, Gradle will run in incubating parallel mode. 11 | # This option should only be used with decoupled projects. More details, visit 12 | # http://www.gradle.org/docs/current/userguide/multi_project_builds.html#sec:decoupled_projects 13 | # org.gradle.parallel=true 14 | # AndroidX package structure to make it clearer which packages are bundled with the 15 | # Android operating system, and which are packaged with your app"s APK 16 | # https://developer.android.com/topic/libraries/support-library/androidx-rn 17 | android.useAndroidX=true 18 | # Enables namespacing of each library's R class so that its R class includes only the 19 | # resources declared in the library itself and none from the library's dependencies, 20 | # thereby reducing the size of the R class for that library 21 | android.nonTransitiveRClass=true 22 | android.nonFinalResIds=false -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Built application files 2 | *.apk 3 | *.aar 4 | *.ap_ 5 | *.aab 6 | 7 | # Files for the ART/Dalvik VM 8 | *.dex 9 | 10 | # Java class files 11 | *.class 12 | 13 | # Generated files 14 | bin/ 15 | gen/ 16 | out/ 17 | # Uncomment the following line in case you need and you don't have the release build type files in your app 18 | # release/ 19 | 20 | # Gradle files 21 | .gradle/ 22 | build/ 23 | 24 | # Local configuration file (sdk path, etc) 25 | local.properties 26 | 27 | # Proguard folder generated by Eclipse 28 | proguard/ 29 | 30 | # Log Files 31 | *.log 32 | 33 | # Android Studio Navigation editor temp files 34 | .navigation/ 35 | 36 | # Android Studio captures folder 37 | captures/ 38 | 39 | # IntelliJ 40 | .idea/ 41 | 42 | # Keystore files 43 | # Uncomment the following lines if you do not want to check your keystore files in. 44 | #*.jks 45 | #*.keystore 46 | 47 | # External native build folder generated in Android Studio 2.2 and later 48 | .externalNativeBuild 49 | .cxx/ 50 | 51 | # Google Services (e.g. APIs or Firebase) 52 | # google-services.json 53 | 54 | # Freeline 55 | freeline.py 56 | freeline/ 57 | freeline_project_description.json 58 | 59 | # fastlane 60 | fastlane/report.xml 61 | fastlane/Preview.html 62 | fastlane/screenshots 63 | fastlane/test_output 64 | fastlane/readme.md 65 | 66 | # Version control 67 | vcs.xml 68 | 69 | # lint 70 | lint/intermediates/ 71 | lint/generated/ 72 | lint/outputs/ 73 | lint/tmp/ 74 | # lint/reports/ 75 | app/release/output-metadata.json 76 | -------------------------------------------------------------------------------- /app/src/main/res/values/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 30 | -------------------------------------------------------------------------------- /app/src/main/res/values-night/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 30 | -------------------------------------------------------------------------------- /app/src/main/java/com/clusterrr/usbserialtelnetserver/BootCompletedReceiver.java: -------------------------------------------------------------------------------- 1 | package com.clusterrr.usbserialtelnetserver; 2 | 3 | import android.content.BroadcastReceiver; 4 | import android.content.Context; 5 | import android.content.Intent; 6 | import android.content.SharedPreferences; 7 | import android.os.Build; 8 | import android.os.Handler; 9 | import android.os.Looper; 10 | import android.util.Log; 11 | import android.widget.Toast; 12 | 13 | import com.hoho.android.usbserial.driver.UsbSerialPort; 14 | 15 | public class BootCompletedReceiver extends BroadcastReceiver { 16 | 17 | @Override 18 | public void onReceive(Context context, Intent intent) { 19 | SharedPreferences prefs = context.getApplicationContext().getSharedPreferences(context.getString(R.string.app_name), Context.MODE_PRIVATE); 20 | if ((prefs.getInt(MainActivity.SETTING_AUTOSTART, MainActivity.AUTOSTART_DISABLED) != MainActivity.AUTOSTART_DISABLED)) 21 | { 22 | switch (UsbSerialTelnetService.getDeviceStatus(context)) { 23 | case NO_DEVICE: 24 | return; 25 | case NO_PERMISSION: 26 | Log.e(UsbSerialTelnetService.TAG, context.getString(R.string.missing_usb_device_permission)); 27 | new Handler(Looper.getMainLooper()).post(() 28 | -> Toast.makeText(context, R.string.missing_usb_device_permission, Toast.LENGTH_LONG).show()); 29 | case OK: 30 | break; 31 | } 32 | 33 | Intent mainActivityStartIntent = new Intent(context, MainActivity.class); 34 | mainActivityStartIntent.setAction(intent.getAction()); 35 | mainActivityStartIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK); 36 | context.startActivity(mainActivityStartIntent); 37 | } 38 | } 39 | } -------------------------------------------------------------------------------- /app/src/main/java/com/clusterrr/usbserialtelnetserver/ConnectedReceiver.java: -------------------------------------------------------------------------------- 1 | package com.clusterrr.usbserialtelnetserver; 2 | 3 | import android.content.BroadcastReceiver; 4 | import android.content.Context; 5 | import android.content.Intent; 6 | import android.content.SharedPreferences; 7 | import android.os.Handler; 8 | import android.os.Looper; 9 | import android.util.Log; 10 | import android.widget.Toast; 11 | 12 | public class ConnectedReceiver extends BroadcastReceiver { 13 | 14 | @Override 15 | public void onReceive(Context context, Intent intent) { 16 | if (BuildConfig.DEBUG) { 17 | Log.d(UsbSerialTelnetService.TAG, "Connected device detected"); 18 | } 19 | SharedPreferences prefs = context.getApplicationContext().getSharedPreferences(context.getString(R.string.app_name), Context.MODE_PRIVATE); 20 | if (prefs.getInt(MainActivity.SETTING_AUTOSTART, MainActivity.AUTOSTART_DISABLED) != MainActivity.AUTOSTART_DISABLED) 21 | { 22 | switch (UsbSerialTelnetService.getDeviceStatus(context)) { 23 | case NO_DEVICE: 24 | Log.wtf(UsbSerialTelnetService.TAG, context.getString(R.string.device_not_found)); 25 | return; 26 | case NO_PERMISSION: 27 | Log.e(UsbSerialTelnetService.TAG, context.getString(R.string.missing_usb_device_permission)); 28 | new Handler(Looper.getMainLooper()).post(() 29 | -> Toast.makeText(context, R.string.missing_usb_device_permission, Toast.LENGTH_LONG).show()); 30 | case OK: 31 | break; 32 | } 33 | 34 | Intent mainActivityStartIntent = new Intent(context, MainActivity.class); 35 | mainActivityStartIntent.setAction(intent.getAction()); 36 | mainActivityStartIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK); 37 | context.startActivity(mainActivityStartIntent); 38 | } 39 | } 40 | } -------------------------------------------------------------------------------- /app/src/main/res/xml/usb_device_filter.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # USB Serial Telnet Server 2 | Android application that binds a USB serial converter to a Telnet client 3 | 4 | Just connect a USB serial adapter into USB OTG port of your Android device, start this app and connect to it using any Telnet client like 5 | * [JuiceSSH](https://play.google.com/store/apps/details?id=com.sonelli.juicessh) using the same Android device (connect to the localhost) 6 | * [Termux](https://play.google.com/store/apps/details?id=com.termux) and standard Linux telnet client (also, connect to the localhost) 7 | * Telnet client on a computer on the same network (connect over Wi-Fi) 8 | 9 | ![Screenshot](https://user-images.githubusercontent.com/4236181/170989042-b82958ff-372b-4733-bbcb-ce98ebf331fc.png) 10 | 11 | This method allows to use all console features like colors and special keys. So you can easily control/install something like network devices with serial port using only your Android device. Also, you can use it as remote console transmitter. 12 | 13 | ![Photo](https://user-images.githubusercontent.com/4236181/170874522-11253639-8eb8-4a95-b70d-e875a2f2baad.jpg) 14 | 15 | ## Compatible Devices 16 | This app uses [usb-serial-for-android library by mik3y](https://github.com/mik3y/usb-serial-for-android) and supports USB to serial converter chips: 17 | * FTDI FT232R, FT232H, FT2232H, FT4232H, FT230X, FT231X, FT234XD 18 | * Prolific PL2303 19 | * Silabs CP2102 and all other CP210x 20 | * Qinheng CH340, CH341A 21 | 22 | Some other device specific drivers: 23 | * GsmModem devices, e.g. for Unisoc based Fibocom GSM modems 24 | * Chrome OS CCD (Closed Case Debugging) 25 | 26 | And devices implementing the generic CDC/ACM protocol like: 27 | * Qinheng CH9102 28 | * Microchip MCP2221 29 | * Arduino using ATmega32U4 30 | * Digispark using V-USB software USB 31 | * ... 32 | 33 | ## Download 34 | You can download USB Serial Telnet Server: 35 | * On [Google Play](https://play.google.com/store/apps/details?id=com.clusterrr.usbserialtelnetserver) - best method, but new versions can be delayed 36 | * At [IzzyOnDroid](https://apt.izzysoft.de/packages/com.clusterrr.usbserialtelnetserver) - new versions usually within 24 hours of their release 37 | * At [releases page](https://github.com/ClusterM/usb-serial-telnet-server/releases) - always actual release version 38 | * Also, you can download automatic interim builds at [http://clusterm.github.io/usb-serial-telnet-server/](http://clusterm.github.io/usb-serial-telnet-server/) - if you want to test some unreleased features, can be buggy, not signed 39 | 40 | ## Donate 41 | * [Become a sponsor on GitHub](https://github.com/sponsors/ClusterM) 42 | * [Buy Me A Coffee](https://www.buymeacoffee.com/cluster) 43 | * [Donation Alerts](https://www.donationalerts.com/r/clustermeerkat) 44 | * [Boosty](https://boosty.to/cluster) 45 | 46 | ## Contacts 47 | * My site (Russian): https://cluster.wtf 48 | * Email: cluster@cluster.wtf 49 | * Telegram: https://t.me/Cluster_M 50 | -------------------------------------------------------------------------------- /app/src/main/java/com/clusterrr/usbserialtelnetserver/UsbSerialThread.java: -------------------------------------------------------------------------------- 1 | package com.clusterrr.usbserialtelnetserver; 2 | 3 | import android.content.Context; 4 | import android.content.SharedPreferences; 5 | import android.os.Handler; 6 | import android.util.Log; 7 | 8 | import com.hoho.android.usbserial.driver.UsbSerialPort; 9 | 10 | import java.io.IOException; 11 | 12 | public class UsbSerialThread extends Thread { 13 | final static int WRITE_TIMEOUT = 1000; 14 | 15 | private UsbSerialTelnetService mUsbSerialTelnetService; 16 | private UsbSerialPort mSerialPort; 17 | private Handler mHandler; 18 | 19 | public UsbSerialThread(UsbSerialTelnetService usbSerialTelnetService, UsbSerialPort serialPort) { 20 | mUsbSerialTelnetService = usbSerialTelnetService; 21 | mSerialPort = serialPort; 22 | mHandler = new Handler(); 23 | } 24 | 25 | @Override 26 | public void run() { 27 | byte[] buffer = new byte[1024]; 28 | 29 | try { 30 | while (true) { 31 | if (mSerialPort == null) break; 32 | // Read data 33 | int l = mSerialPort.read(buffer, 0); 34 | if (l <= 0) break; // disconnect 35 | if (BuildConfig.DEBUG) { 36 | StringBuilder hexStr = new StringBuilder(); 37 | for (int i = 0; i < l; i++) { 38 | hexStr.append(String.format("%02X ", buffer[i])); 39 | } 40 | Log.d(UsbSerialTelnetService.TAG, "Received " + l + " bytes from port: " + hexStr.toString().trim()); 41 | } 42 | // Write data 43 | mUsbSerialTelnetService.writeClients(buffer, 0, l); 44 | } 45 | } 46 | catch (IOException e) { 47 | Log.i(UsbSerialTelnetService.TAG, "Serial port: " + e.getMessage()); 48 | markStopped(); 49 | } 50 | catch (Exception e) { 51 | e.printStackTrace(); 52 | markStopped(); 53 | } 54 | close(); 55 | Log.i(UsbSerialTelnetService.TAG, "Serial port closed"); 56 | mUsbSerialTelnetService.stopSelf(); 57 | } 58 | 59 | public void write(byte[] data) throws IOException { 60 | if (mSerialPort != null) 61 | mSerialPort.write(data, WRITE_TIMEOUT); 62 | } 63 | 64 | public void close() { 65 | try { 66 | if (mSerialPort != null) 67 | mSerialPort.close(); 68 | } catch (Exception e) { 69 | e.printStackTrace(); 70 | } 71 | mSerialPort = null; 72 | } 73 | 74 | private void markStopped() 75 | { 76 | SharedPreferences prefs = mUsbSerialTelnetService.getApplicationContext().getSharedPreferences(mUsbSerialTelnetService.getString(R.string.app_name), Context.MODE_PRIVATE); 77 | prefs.edit().putBoolean(UsbSerialTelnetService.KEY_LAST_STATE, false).apply(); 78 | } 79 | } 80 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 24 | 25 | 30 | 31 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 48 | 49 | 50 | 54 | 55 | 56 | 57 | 58 | 61 | 62 | 63 | 66 | 67 | 68 | 69 | 70 | 71 | 72 | -------------------------------------------------------------------------------- /app/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | USB Serial Telnet Server 3 | Started, please connect to: 4 | Not started 5 | Start 6 | Stop 7 | TCP port to listen 8 | Baud rate 9 | Data bits 10 | Stop bits 11 | Parity 12 | started 13 | Error: USB serial device not found 14 | Error: missing USB device permission 15 | Error: 16 | stopped 17 | Already started 18 | Forced local echo off 19 | Convert client\'s CR-LF to CR 20 | Autostart 21 | Local connections only 22 | Port ID 23 | Invalid port ID. Note: most devices have just one port - #0. 24 | Enable it to restrict the server to local connections\u00A0only 25 | Set the TCP port to listen for incoming\u00A0connections 26 | Select the port ID, most devices have only\u00A0port\u00A0#0 27 | Set the baud rate for the serial connection 28 | Set the number of data bits for the serial connection, usually\u00A08 29 | Set the number of stop bits for the serial connection, usually\u00A01 30 | Set the parity for the serial connection, usually\u00A0\"none\" 31 | Disable local echo in the terminal for remote-only\u00A0output 32 | Replace CR-LF with LF in case if your device expects\u00A0LF\u00A0only 33 | Automatically start the server when a\u00A0device\u00A0is\u00A0connected 34 | 35 | Port #0 36 | Port #1 37 | Port #2 38 | Port #3 39 | 40 | 41 | 5 42 | 6 43 | 7 44 | 8 45 | 9 46 | 47 | 48 | 1 stop bit 49 | 1.5 stop bits 50 | 2 stop bits 51 | 52 | 53 | None 54 | Odd 55 | Even 56 | Mark 57 | Space 58 | 59 | 60 | Disabled 61 | Enabled 62 | +Autoclose 63 | 64 | -------------------------------------------------------------------------------- /.github/workflows/android.yml: -------------------------------------------------------------------------------- 1 | name: Build 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | workflow_dispatch: 9 | 10 | # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages 11 | permissions: 12 | contents: read 13 | pages: write 14 | id-token: write 15 | 16 | jobs: 17 | build-debug: 18 | name: Build debug APK 19 | runs-on: ubuntu-latest 20 | 21 | steps: 22 | - name: Checkout source code 23 | uses: actions/checkout@v4 24 | 25 | - name: Set up JDK 26 | uses: actions/setup-java@v3 27 | with: 28 | distribution: 'zulu' 29 | java-version: '17' 30 | 31 | - name: Cache Gradle 32 | uses: actions/cache@v3 33 | with: 34 | path: | 35 | ~/.gradle/caches 36 | ~/.gradle/wrapper 37 | key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }} 38 | restore-keys: | 39 | gradle-${{ runner.os }}- 40 | 41 | - name: Grant execute permission for gradlew 42 | run: chmod +x ./gradlew 43 | 44 | - name: Build debug APK 45 | run: ./gradlew assembleDebug 46 | 47 | - name: Upload debug APK 48 | uses: actions/upload-artifact@v4 49 | with: 50 | name: debug-apk 51 | path: app/build/outputs/apk/debug 52 | 53 | build-release: 54 | name: Build release APK 55 | runs-on: ubuntu-latest 56 | 57 | steps: 58 | - name: Checkout source code 59 | uses: actions/checkout@v4 60 | 61 | - name: Set up JDK 62 | uses: actions/setup-java@v3 63 | with: 64 | distribution: 'zulu' 65 | java-version: '17' 66 | 67 | - name: Cache Gradle 68 | uses: actions/cache@v3 69 | with: 70 | path: | 71 | ~/.gradle/caches 72 | ~/.gradle/wrapper 73 | key: gradle-${{ runner.os }}-${{ hashFiles('**/*.gradle*', '**/gradle-wrapper.properties') }} 74 | restore-keys: | 75 | gradle-${{ runner.os }}- 76 | 77 | - name: Grant execute permission for gradlew 78 | run: chmod +x ./gradlew 79 | 80 | - name: Build release APK 81 | run: ./gradlew assembleRelease 82 | 83 | - name: Upload release APK 84 | uses: actions/upload-artifact@v4 85 | with: 86 | name: release-apk 87 | path: app/build/outputs/apk/release 88 | 89 | upload-to-pages: 90 | needs: [build-release, build-debug] 91 | runs-on: ubuntu-latest 92 | steps: 93 | - name: Download artifacts 94 | uses: actions/download-artifact@v4 95 | - name: Move files to the root 96 | run: find -name *.apk -exec mv {} . \; 97 | - name: Remove unused directories 98 | run: rm -rf release-apk debug-apk 99 | - name: Generate index.html 100 | run: "(echo \"USB Servial Telnet Server

USB Servial Telnet Server

This is automatic interim builds. Install those apk's only if you want to test some unreleased features. Can be buggy, not signed.

Updated: `date`

\" ; for file in *.apk ; do echo \"$file
\" ; done ; echo \"\") > index.html" 101 | - name: Upload artifact 102 | uses: actions/upload-pages-artifact@v3 103 | with: 104 | path: '.' 105 | - name: Deploy to GitHub Pages 106 | id: deployment 107 | uses: actions/deploy-pages@v4 108 | if: github.event_name != 'pull_request' 109 | -------------------------------------------------------------------------------- /app/src/main/java/com/clusterrr/usbserialtelnetserver/TcpServerThread.java: -------------------------------------------------------------------------------- 1 | package com.clusterrr.usbserialtelnetserver; 2 | 3 | import android.util.Log; 4 | 5 | import java.io.IOException; 6 | import java.net.ServerSocket; 7 | import java.net.Socket; 8 | import java.net.SocketException; 9 | import java.util.ArrayList; 10 | import java.util.List; 11 | 12 | public class TcpServerThread extends Thread { 13 | private final UsbSerialTelnetService mUsbSerialTelnetService; 14 | private ServerSocket mTcpServer; 15 | private final List mClients; 16 | private boolean mNoLocalEcho = true; 17 | private boolean mRemoveLf = true; 18 | 19 | public TcpServerThread(UsbSerialTelnetService usbSerialTelnetService, ServerSocket tcpServer) { 20 | mUsbSerialTelnetService = usbSerialTelnetService; 21 | mTcpServer = tcpServer; 22 | mClients = new ArrayList<>(); 23 | } 24 | 25 | @Override 26 | public void run() { 27 | try { 28 | while (true) { 29 | if (mTcpServer == null) break; 30 | Socket socket = mTcpServer.accept(); 31 | Log.i(UsbSerialTelnetService.TAG, "Connected: " + socket.getRemoteSocketAddress()); 32 | TcpClientThread client = new TcpClientThread(mUsbSerialTelnetService, this, socket); 33 | client.setNoLocalEcho(mNoLocalEcho); 34 | client.setRemoveLf(mRemoveLf); 35 | client.start(); 36 | mClients.add(client); 37 | } 38 | } catch (SocketException e) { 39 | Log.i(UsbSerialTelnetService.TAG, "Server: " + e.getMessage()); 40 | } catch (Exception e) { 41 | e.printStackTrace(); 42 | } 43 | close(); 44 | Log.i(UsbSerialTelnetService.TAG, "Server: stopped"); 45 | } 46 | 47 | public void removeClient(TcpClientThread tcpClientThread) { 48 | mClients.remove(tcpClientThread); 49 | } 50 | 51 | public void write(byte[] data) throws IOException { 52 | write(data, 0, data.length); 53 | } 54 | 55 | public void write(byte[] data, int offset, int len) throws IOException { 56 | List toRemove = new ArrayList<>(); 57 | for (TcpClientThread client : mClients) { 58 | try { 59 | client.write(data, offset, len); 60 | if (BuildConfig.DEBUG) { 61 | Log.d(UsbSerialTelnetService.TAG, "Written " + len + " bytes to the client " + client.getRemoteSocketAddress()); 62 | } 63 | } catch (Exception ex) { 64 | ex.printStackTrace(); 65 | toRemove.add(client); 66 | } 67 | } 68 | for (TcpClientThread client : toRemove) { 69 | client.close(); 70 | mClients.remove(client); 71 | } 72 | } 73 | 74 | public void close() { 75 | try { 76 | if (mTcpServer != null) 77 | mTcpServer.close(); 78 | } catch (IOException e) { 79 | e.printStackTrace(); 80 | } 81 | mTcpServer = null; 82 | for (TcpClientThread client : mClients) { 83 | try { 84 | client.close(); 85 | } catch (Exception e) { 86 | e.printStackTrace(); 87 | } 88 | } 89 | mClients.clear(); 90 | } 91 | 92 | public void setNoLocalEcho(boolean noLocalEcho) { 93 | mNoLocalEcho = noLocalEcho; 94 | } 95 | 96 | public void setRemoveLf(boolean removeLf) { 97 | mRemoveLf = removeLf; 98 | } 99 | } -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> \(.*\)$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | 86 | # Determine the Java command to use to start the JVM. 87 | if [ -n "$JAVA_HOME" ] ; then 88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 89 | # IBM's JDK on AIX uses strange locations for the executables 90 | JAVACMD="$JAVA_HOME/jre/sh/java" 91 | else 92 | JAVACMD="$JAVA_HOME/bin/java" 93 | fi 94 | if [ ! -x "$JAVACMD" ] ; then 95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 96 | 97 | Please set the JAVA_HOME variable in your environment to match the 98 | location of your Java installation." 99 | fi 100 | else 101 | JAVACMD="java" 102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 103 | 104 | Please set the JAVA_HOME variable in your environment to match the 105 | location of your Java installation." 106 | fi 107 | 108 | # Increase the maximum file descriptors if we can. 109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 110 | MAX_FD_LIMIT=`ulimit -H -n` 111 | if [ $? -eq 0 ] ; then 112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 113 | MAX_FD="$MAX_FD_LIMIT" 114 | fi 115 | ulimit -n $MAX_FD 116 | if [ $? -ne 0 ] ; then 117 | warn "Could not set maximum file descriptor limit: $MAX_FD" 118 | fi 119 | else 120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 121 | fi 122 | fi 123 | 124 | # For Darwin, add options to specify how the application appears in the dock 125 | if $darwin; then 126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 127 | fi 128 | 129 | # For Cygwin or MSYS, switch paths to Windows format before running java 130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then 131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 133 | 134 | JAVACMD=`cygpath --unix "$JAVACMD"` 135 | 136 | # We build the pattern for arguments to be converted via cygpath 137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 138 | SEP="" 139 | for dir in $ROOTDIRSRAW ; do 140 | ROOTDIRS="$ROOTDIRS$SEP$dir" 141 | SEP="|" 142 | done 143 | OURCYGPATTERN="(^($ROOTDIRS))" 144 | # Add a user-defined pattern to the cygpath arguments 145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 147 | fi 148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 149 | i=0 150 | for arg in "$@" ; do 151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 153 | 154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 156 | else 157 | eval `echo args$i`="\"$arg\"" 158 | fi 159 | i=`expr $i + 1` 160 | done 161 | case $i in 162 | 0) set -- ;; 163 | 1) set -- "$args0" ;; 164 | 2) set -- "$args0" "$args1" ;; 165 | 3) set -- "$args0" "$args1" "$args2" ;; 166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;; 167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 172 | esac 173 | fi 174 | 175 | # Escape application args 176 | save () { 177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 178 | echo " " 179 | } 180 | APP_ARGS=`save "$@"` 181 | 182 | # Collect all arguments for the java command, following the shell quoting and substitution rules 183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 184 | 185 | exec "$JAVACMD" "$@" 186 | -------------------------------------------------------------------------------- /app/src/main/java/com/clusterrr/usbserialtelnetserver/TcpClientThread.java: -------------------------------------------------------------------------------- 1 | package com.clusterrr.usbserialtelnetserver; 2 | 3 | import android.util.Log; 4 | 5 | import java.io.IOException; 6 | import java.io.InputStream; 7 | import java.io.OutputStream; 8 | import java.net.Socket; 9 | import java.net.SocketAddress; 10 | import java.net.SocketException; 11 | import java.util.ArrayList; 12 | import java.util.List; 13 | 14 | public class TcpClientThread extends Thread { 15 | private final UsbSerialTelnetService mUsbSerialTelnetService; 16 | private final TcpServerThread mTcpServerThread; 17 | private Socket mSocket; 18 | private InputStream mDataInputStream; 19 | private OutputStream mDataOutputStream; 20 | private final String mAddress; 21 | private final List mBuffer; 22 | private boolean mNoLocalEcho = true; 23 | private boolean mRemoveLf = true; 24 | private byte mLastChar = 0; 25 | 26 | final static byte CMD_WILL = (byte) 0xFB; 27 | final static byte CMD_WONT = (byte) 0xFC; 28 | final static byte CMD_DO = (byte) 0xFD; 29 | final static byte CMD_DONT = (byte) 0xFE; 30 | final static byte OP_ECHO = (byte) 1; 31 | final static byte OP_SUPPRESS = (byte) 3; 32 | 33 | public TcpClientThread(UsbSerialTelnetService usbSerialTelnetService, TcpServerThread tcpServerThread, Socket socket) throws IOException { 34 | mUsbSerialTelnetService = usbSerialTelnetService; 35 | mTcpServerThread = tcpServerThread; 36 | mSocket = socket; 37 | mDataInputStream = mSocket.getInputStream(); 38 | mDataOutputStream = mSocket.getOutputStream(); 39 | mAddress = mSocket.getRemoteSocketAddress().toString(); 40 | mBuffer = new ArrayList<>(); 41 | } 42 | 43 | @Override 44 | public void run() { 45 | byte buffer[] = new byte[1024]; 46 | 47 | try { 48 | if (mNoLocalEcho) { 49 | mDataOutputStream.write(new byte[]{(byte) 0xFF, CMD_WILL, OP_ECHO}); // Will Echo 50 | mDataOutputStream.write(new byte[]{(byte) 0xFF, CMD_DONT, OP_ECHO}); // Don't Echo 51 | mDataOutputStream.write(new byte[]{(byte) 0xFF, CMD_DO, OP_SUPPRESS}); // Do Suppress Go Ahead 52 | mDataOutputStream.write(new byte[]{(byte) 0xFF, CMD_WILL, OP_SUPPRESS}); // Will Suppress Go Ahead 53 | } 54 | 55 | while (true) { 56 | if (mDataInputStream == null) break; 57 | int l = mDataInputStream.read(buffer); 58 | if (l <= 0) break; // disconnect 59 | for (int i = 0; i < l; i++) 60 | mBuffer.add(buffer[i]); 61 | if (BuildConfig.DEBUG) { 62 | StringBuilder hexStr = new StringBuilder(); 63 | for (int i = 0; i < l; i++) { 64 | hexStr.append(String.format("%02X ", buffer[i])); 65 | } 66 | Log.d(UsbSerialTelnetService.TAG, "Received " + l + " bytes from client: " + hexStr.toString().trim()); 67 | } 68 | proceedBuffer(); 69 | } 70 | } 71 | catch (SocketException e) { 72 | Log.i(UsbSerialTelnetService.TAG, mAddress + ": " + e.getMessage()); 73 | } 74 | catch (IOException e) { 75 | e.printStackTrace(); 76 | } 77 | 78 | try { 79 | if (mSocket != null) 80 | mSocket.close(); 81 | } catch (IOException e) { 82 | e.printStackTrace(); 83 | } 84 | mSocket = null; 85 | mDataInputStream = null; 86 | mDataOutputStream = null; 87 | mTcpServerThread.removeClient(this); 88 | Log.i(UsbSerialTelnetService.TAG, mAddress + ": stopped"); 89 | } 90 | 91 | private void proceedBuffer() throws IOException { 92 | int len = mBuffer.size(); 93 | int i = 0; 94 | List output = new ArrayList<>(); 95 | for (; i < len; i++) { 96 | byte b = mBuffer.get(i); 97 | if (b == 0) continue; 98 | if (mRemoveLf && mLastChar == '\r' && b == '\n') { 99 | // remove LF if need 100 | mLastChar = '\n'; 101 | continue; 102 | } 103 | if (b == (byte)0xFF) { 104 | if (i + 1 >= len) break; 105 | byte next = mBuffer.get(i + 1); 106 | if (next == (byte)0xFF) { 107 | // just 0xFF 108 | output.add((byte)0xFF); 109 | mLastChar = (byte)0xFF; 110 | i++; 111 | continue; 112 | } 113 | // Command 114 | if (i + 2 >= len) break; 115 | byte cmd = next; 116 | byte opt = mBuffer.get(i + 2); 117 | if (BuildConfig.DEBUG) { 118 | Log.d(UsbSerialTelnetService.TAG, "Telnet command: CMD=" + (cmd >= 0 ? cmd : cmd + 256) + " ARG=" + (opt >= 0 ? opt : opt + 256)); 119 | } 120 | i += 2; 121 | continue; 122 | } 123 | // just data 124 | output.add(b); 125 | mLastChar = b; 126 | } 127 | 128 | // Remove proceeded 129 | mBuffer.subList(0, i).clear(); 130 | 131 | // And finally write data to the port 132 | //mUsbSerialTelnetService.writeSerialPort(Bytes.toArray(output)); // Guava lib make app too large :( 133 | byte[] outputPrimitive = new byte[output.size()]; 134 | for (i = 0; i < outputPrimitive.length; i++) 135 | outputPrimitive[i] = output.get(i); 136 | mUsbSerialTelnetService.writeSerialPort(outputPrimitive); 137 | } 138 | 139 | public void write(byte[] data) throws IOException { 140 | write(data, 0, data.length); 141 | } 142 | 143 | public void write(byte[] data, int offset, int len) throws IOException { 144 | if (mDataOutputStream == null) return; 145 | List output = new ArrayList<>(); 146 | for (int i = 0; i < len; i++){ 147 | byte b = data[offset + i]; 148 | if (b != (byte)0xFF) { 149 | output.add(b); 150 | } else { 151 | // Escape 0xFF 152 | output.add((byte)0xFF); 153 | output.add((byte)0xFF); 154 | } 155 | } 156 | 157 | // mDataOutputStream.write(Bytes.toArray(output)); // Guava lib make app too large :( 158 | byte[] outputPrimitive = new byte[output.size()]; 159 | for (int i = 0; i < outputPrimitive.length; i++) 160 | outputPrimitive[i] = output.get(i); 161 | mDataOutputStream.write(outputPrimitive); 162 | } 163 | 164 | public void close() { 165 | try { 166 | if (mSocket != null) { 167 | mSocket.close(); 168 | } 169 | if (mDataOutputStream != null) { 170 | mDataOutputStream.close(); 171 | } 172 | if (mDataInputStream != null) 173 | { 174 | mDataInputStream.close(); 175 | } 176 | } catch (IOException e) { 177 | e.printStackTrace(); 178 | } 179 | mSocket = null; 180 | mDataOutputStream = null; 181 | mDataInputStream = null; 182 | } 183 | 184 | public SocketAddress getRemoteSocketAddress() { 185 | return mSocket.getRemoteSocketAddress(); 186 | } 187 | 188 | public void setNoLocalEcho(boolean noLocalEcho) { 189 | mNoLocalEcho = noLocalEcho; 190 | } 191 | 192 | public void setRemoveLf(boolean removeLf) { 193 | mRemoveLf = removeLf; 194 | } 195 | } 196 | -------------------------------------------------------------------------------- /app/src/main/java/com/clusterrr/usbserialtelnetserver/UsbSerialTelnetService.java: -------------------------------------------------------------------------------- 1 | package com.clusterrr.usbserialtelnetserver; 2 | 3 | import android.app.Notification; 4 | import android.app.NotificationChannel; 5 | import android.app.NotificationManager; 6 | import android.app.PendingIntent; 7 | import android.app.Service; 8 | import android.content.Context; 9 | import android.content.Intent; 10 | import android.content.pm.ServiceInfo; 11 | import android.graphics.BitmapFactory; 12 | import android.hardware.usb.UsbDeviceConnection; 13 | import android.hardware.usb.UsbManager; 14 | import android.hardware.usb.UsbDevice; 15 | import android.os.Binder; 16 | import android.os.Build; 17 | import android.os.Handler; 18 | import android.os.IBinder; 19 | import android.os.Looper; 20 | import android.util.Log; 21 | import android.widget.Toast; 22 | 23 | import androidx.core.app.NotificationCompat; 24 | 25 | import com.hoho.android.usbserial.driver.UsbSerialDriver; 26 | import com.hoho.android.usbserial.driver.UsbSerialPort; 27 | import com.hoho.android.usbserial.driver.UsbSerialProber; 28 | 29 | import java.io.IOException; 30 | import java.net.Inet4Address; 31 | import java.net.InetAddress; 32 | import java.net.InterfaceAddress; 33 | import java.net.NetworkInterface; 34 | import java.net.ServerSocket; 35 | import java.util.Enumeration; 36 | import java.util.List; 37 | 38 | public class UsbSerialTelnetService extends Service { 39 | final static String TAG = "UsbSerialTelnet"; 40 | final static String ACTION_NEED_TO_START = "need_to_start"; 41 | final static String KEY_LOCAL_ONLY = "local_only"; 42 | final static String KEY_TCP_PORT = "tcp_port"; 43 | final static String KEY_PORT_ID = "port_id"; 44 | final static String KEY_BAUD_RATE = "baud_rate"; 45 | final static String KEY_DATA_BITS = "data_bits"; 46 | final static String KEY_STOP_BITS = "stop_bits"; 47 | final static String KEY_PARITY = "parity"; 48 | final static String KEY_NO_LOCAL_ECHO = "no_local_echo"; 49 | final static String KEY_REMOVE_LF = "remove_lf"; 50 | final static String KEY_LAST_STATE = "last_state"; 51 | 52 | boolean mStarted = false; 53 | //UsbSerialPort mSerialPort = null; 54 | UsbSerialThread mUsbSerialThread = null; 55 | TcpServerThread mTcpServerThread = null; 56 | 57 | int mTcpPort = 2323; 58 | 59 | public UsbSerialTelnetService() { 60 | } 61 | 62 | public enum UsbDeviceStatus { 63 | NO_DEVICE, 64 | NO_PERMISSION, 65 | OK 66 | } 67 | 68 | @Override 69 | public IBinder onBind(Intent intent) { 70 | return mBinder; 71 | } 72 | 73 | @Override 74 | public int onStartCommand(Intent intent, int flags, int startId) 75 | { 76 | if (mStarted) { 77 | // Already started 78 | //new Handler(Looper.getMainLooper()).post(() -> Toast.makeText(UsbSerialTelnetService.this.getApplicationContext(), getString(R.string.already_started), Toast.LENGTH_LONG).show()); 79 | return START_STICKY; 80 | } 81 | 82 | String message = getString(R.string.app_name) + " " + getString(R.string.started); 83 | 84 | Intent mainActivityIntent = new Intent(this, MainActivity.class); 85 | PendingIntent mainActivityPendingIntent = PendingIntent.getActivity(this, 0, mainActivityIntent, PendingIntent.FLAG_IMMUTABLE); 86 | NotificationManager nm = (NotificationManager) getSystemService(NOTIFICATION_SERVICE); 87 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) { 88 | NotificationChannel channel = new NotificationChannel(TAG, 89 | getString(R.string.app_name), 90 | NotificationManager.IMPORTANCE_DEFAULT); 91 | channel.setDescription(getString(R.string.app_name)); 92 | nm.createNotificationChannel(channel); 93 | } 94 | Notification notification = new NotificationCompat.Builder(this, TAG) 95 | .setOngoing(true) 96 | .setSmallIcon(R.drawable.ic_notification) 97 | .setLargeIcon(BitmapFactory.decodeResource(this.getResources(), R.mipmap.ic_launcher)) 98 | .setContentTitle(message) 99 | .setPriority(NotificationCompat.PRIORITY_HIGH) 100 | .setCategory(Notification.CATEGORY_SERVICE) 101 | .setShowWhen(false) 102 | .setContentIntent(mainActivityPendingIntent) 103 | .setSound(null) 104 | .build(); 105 | 106 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) { 107 | startForeground(1, notification, ServiceInfo.FOREGROUND_SERVICE_TYPE_CONNECTED_DEVICE); 108 | } else { 109 | startForeground(1, notification); 110 | } 111 | 112 | boolean success = false; 113 | 114 | try { 115 | // Find all available drivers from attached devices. 116 | UsbManager manager = (UsbManager) getSystemService(Context.USB_SERVICE); 117 | List availableDrivers = UsbSerialProber.getDefaultProber().findAllDrivers(manager); 118 | if (availableDrivers.isEmpty()) { 119 | message = getString(R.string.device_not_found); 120 | } else { 121 | // Open a connection to the first available driver. 122 | UsbSerialDriver driver = availableDrivers.get(0); 123 | UsbDeviceConnection connection = manager.openDevice(driver.getDevice()); 124 | if (connection == null) { 125 | message = null; // "Please grant permission and try again"; 126 | Intent mainActivityStartIntent = new Intent(this, MainActivity.class); 127 | mainActivityStartIntent.setAction(ACTION_NEED_TO_START); 128 | PendingIntent mainActivityStartPendingIntent = PendingIntent.getActivity(this, 0, mainActivityStartIntent, PendingIntent.FLAG_IMMUTABLE); 129 | manager.requestPermission(driver.getDevice(), mainActivityStartPendingIntent); 130 | } else { 131 | UsbSerialPort serialPort = null; 132 | try { 133 | serialPort = driver.getPorts().get(intent.getIntExtra(KEY_PORT_ID, 0)); 134 | } 135 | catch (IndexOutOfBoundsException ex) 136 | { 137 | message = getString(R.string.invalid_port_id); 138 | } 139 | if (serialPort != null) { 140 | serialPort.open(connection); 141 | serialPort.setParameters( 142 | intent.getIntExtra(KEY_BAUD_RATE, 115200), 143 | intent.getIntExtra(KEY_DATA_BITS, 8), 144 | intent.getIntExtra(KEY_STOP_BITS, UsbSerialPort.STOPBITS_1), 145 | intent.getIntExtra(KEY_PARITY, UsbSerialPort.PARITY_NONE)); 146 | ServerSocket serverSocket = intent.getBooleanExtra(KEY_LOCAL_ONLY, false) ? 147 | new ServerSocket(intent.getIntExtra(KEY_TCP_PORT, 2323), -1, InetAddress.getByAddress(new byte[]{127, 0, 0, 1})) : // Explicitly use IPv4, as will default to IPv6 otherwise. 148 | new ServerSocket(intent.getIntExtra(KEY_TCP_PORT, 2323)); 149 | mUsbSerialThread = new UsbSerialThread(this, serialPort); 150 | mTcpServerThread = new TcpServerThread(this, serverSocket); 151 | mTcpServerThread.setNoLocalEcho(intent.getBooleanExtra(KEY_NO_LOCAL_ECHO, true)); 152 | mTcpServerThread.setRemoveLf(intent.getBooleanExtra(KEY_REMOVE_LF, true)); 153 | mUsbSerialThread.start(); 154 | mTcpServerThread.start(); 155 | success = true; 156 | } 157 | } 158 | } 159 | } 160 | catch (Exception ex) { 161 | message = getString(R.string.error) + " " + ex.getMessage(); 162 | ex.printStackTrace(); 163 | } 164 | 165 | if (message != null) { 166 | final String msg = message; 167 | new Handler(Looper.getMainLooper()).post(() -> Toast.makeText(UsbSerialTelnetService.this.getApplicationContext(), msg, Toast.LENGTH_SHORT).show()); 168 | } 169 | 170 | if (success) { 171 | if (message != null) 172 | Log.i(TAG, message); 173 | mStarted = true; 174 | mBinder.started(); 175 | } else { 176 | if (message != null) 177 | Log.e(TAG, message); 178 | stopSelf(); 179 | mStarted = false; 180 | } 181 | 182 | return START_STICKY; 183 | } 184 | 185 | public static UsbDeviceStatus getDeviceStatus(Context context) { 186 | UsbManager manager = (UsbManager) context.getSystemService(Context.USB_SERVICE); 187 | List availableDrivers = UsbSerialProber.getDefaultProber().findAllDrivers(manager); 188 | if (!availableDrivers.isEmpty()) { 189 | UsbSerialDriver driver = availableDrivers.get(0); 190 | UsbDevice device = driver.getDevice(); 191 | return manager.hasPermission(device) ? UsbDeviceStatus.OK :UsbDeviceStatus.NO_PERMISSION; 192 | } 193 | return UsbDeviceStatus.NO_DEVICE; 194 | } 195 | 196 | public static String getIPAddress() { 197 | try { 198 | Enumeration networkInterfaces = NetworkInterface.getNetworkInterfaces(); 199 | while (networkInterfaces.hasMoreElements()) { 200 | NetworkInterface networkInterface = networkInterfaces.nextElement(); 201 | if (networkInterface.isUp()) { 202 | String name = networkInterface.getName(); 203 | if (name.toLowerCase().equals("wlan0") || name.toLowerCase().equals("rmnet0")) { 204 | List interfaceAddresses = networkInterface.getInterfaceAddresses(); 205 | for (InterfaceAddress interfaceAddress : interfaceAddresses) { 206 | InetAddress address = interfaceAddress.getAddress(); 207 | if (address instanceof Inet4Address){ 208 | return address.getHostAddress(); 209 | } 210 | } 211 | } 212 | } 213 | } 214 | } catch (Exception e) { 215 | e.printStackTrace(); 216 | } 217 | return "localhost"; 218 | } 219 | 220 | @Override 221 | public void onDestroy() 222 | { 223 | NotificationManager nm = (NotificationManager) getSystemService(NOTIFICATION_SERVICE); 224 | nm.cancel(1); 225 | if (mTcpServerThread != null) { 226 | mTcpServerThread.close(); 227 | mTcpServerThread = null; 228 | } 229 | if (mUsbSerialThread != null) { 230 | mUsbSerialThread.close(); 231 | mUsbSerialThread = null; 232 | } 233 | if (mStarted) 234 | new Handler(Looper.getMainLooper()).post(() -> Toast.makeText(UsbSerialTelnetService.this.getApplicationContext(), 235 | getString(R.string.app_name) + " " + getString(R.string.stopped), Toast.LENGTH_SHORT).show()); 236 | Log.i(TAG, "Service stopped"); 237 | mStarted = false; 238 | mBinder.stopped(); 239 | } 240 | 241 | private final ServiceBinder mBinder = new ServiceBinder(); 242 | public class ServiceBinder extends Binder { 243 | private IOnStartStopListener onStartStopListener = null; 244 | public boolean isStarted() 245 | { 246 | return mStarted; 247 | } 248 | public void setOnStartStopListener(IOnStartStopListener listener) { onStartStopListener = listener; } 249 | public void started() { if (onStartStopListener != null) onStartStopListener.usbSerialServiceStarted(); } 250 | public void stopped() { if (onStartStopListener != null) onStartStopListener.usbSerialServiceStopped(); } 251 | } 252 | public interface IOnStartStopListener 253 | { 254 | public void usbSerialServiceStarted(); 255 | public void usbSerialServiceStopped(); 256 | } 257 | 258 | public void writeSerialPort(byte[] buffer) throws IOException { 259 | if (mUsbSerialThread == null) return; 260 | mUsbSerialThread.write(buffer); 261 | if (BuildConfig.DEBUG) { 262 | Log.d(UsbSerialTelnetService.TAG, "Written " + buffer.length + " bytes to the port"); 263 | } 264 | } 265 | 266 | public void writeSerialPort(byte[] buffer, int pos, int len) throws IOException { 267 | if (mUsbSerialThread == null) return; 268 | if ((pos != 0) || (buffer.length != len)) { 269 | byte[] writeBuffer = new byte[len]; 270 | System.arraycopy(buffer, pos, writeBuffer, 0, len); 271 | mUsbSerialThread.write(writeBuffer); 272 | } else { 273 | mUsbSerialThread.write(buffer); 274 | } 275 | } 276 | 277 | public void writeClients(byte[] buffer) throws IOException { 278 | if (mTcpServerThread == null) return; 279 | mTcpServerThread.write(buffer); 280 | } 281 | 282 | public void writeClients(byte[] buffer, int pos, int len) throws IOException { 283 | if (mTcpServerThread == null) return; 284 | mTcpServerThread.write(buffer, pos, len); 285 | } 286 | } 287 | -------------------------------------------------------------------------------- /app/src/main/java/com/clusterrr/usbserialtelnetserver/MainActivity.java: -------------------------------------------------------------------------------- 1 | package com.clusterrr.usbserialtelnetserver; 2 | 3 | import androidx.appcompat.app.AppCompatActivity; 4 | import androidx.appcompat.widget.AppCompatButton; 5 | import androidx.appcompat.widget.AppCompatEditText; 6 | import androidx.appcompat.widget.AppCompatSpinner; 7 | import androidx.appcompat.widget.AppCompatTextView; 8 | import androidx.appcompat.widget.SwitchCompat; 9 | import androidx.core.content.ContextCompat; 10 | 11 | import android.Manifest; 12 | import android.app.PendingIntent; 13 | import android.content.ComponentName; 14 | import android.content.Context; 15 | import android.content.Intent; 16 | import android.content.ServiceConnection; 17 | import android.content.SharedPreferences; 18 | import android.content.pm.PackageManager; 19 | import android.hardware.usb.UsbDevice; 20 | import android.hardware.usb.UsbManager; 21 | import android.net.Uri; 22 | import android.os.Build; 23 | import android.os.Bundle; 24 | import android.os.Handler; 25 | import android.os.IBinder; 26 | import android.os.PowerManager; 27 | import android.provider.Settings; 28 | import android.util.Log; 29 | import android.view.View; 30 | import android.widget.AdapterView; 31 | import android.widget.Toast; 32 | 33 | import com.hoho.android.usbserial.driver.UsbSerialDriver; 34 | import com.hoho.android.usbserial.driver.UsbSerialPort; 35 | import com.hoho.android.usbserial.driver.UsbSerialProber; 36 | 37 | import java.util.List; 38 | 39 | public class MainActivity extends AppCompatActivity implements View.OnClickListener, UsbSerialTelnetService.IOnStartStopListener, AdapterView.OnItemSelectedListener { 40 | final static String SETTING_LOCAL_ONLY = "local_only"; 41 | final static String SETTING_TCP_PORT = "tcp_port"; 42 | final static String SETTING_PORT_ID = "port_id"; 43 | final static String SETTING_BAUD_RATE = "baud_rate"; 44 | final static String SETTING_DATA_BITS = "data_bits"; 45 | final static String SETTING_STOP_BITS = "stop_bits"; 46 | final static String SETTING_PARITY = "parity"; 47 | final static String SETTING_NO_LOCAL_ECHO = "no_local_echo"; 48 | final static String SETTING_REMOVE_LF = "remove_lf"; 49 | final static String SETTING_AUTOSTART = "autostart"; 50 | 51 | final static int AUTOSTART_DISABLED = 0; 52 | final static int AUTOSTART_ENABLED = 1; 53 | final static int AUTOSTART_CLOSE = 2; 54 | 55 | private UsbSerialTelnetService.ServiceBinder mServiceBinder = null; 56 | private final Handler mHandler = new Handler(); 57 | private boolean mNeedClose = false; 58 | private AppCompatButton mStartButton; 59 | private AppCompatButton mStopButton; 60 | private SwitchCompat mLocalOnly; 61 | private AppCompatEditText mTcpPort; 62 | private AppCompatSpinner mPortId; 63 | private AppCompatEditText mBaudRate; 64 | private AppCompatSpinner mDataBits; 65 | private AppCompatSpinner mStopBits; 66 | private AppCompatSpinner mParity; 67 | private AppCompatTextView mStatus; 68 | private SwitchCompat mNoLocalEcho; 69 | private SwitchCompat mRemoveLF; 70 | private AppCompatSpinner mAutostart; 71 | 72 | public boolean isStarted() { 73 | return mServiceBinder != null && mServiceBinder.isStarted(); 74 | } 75 | 76 | @Override 77 | protected void onCreate(Bundle savedInstanceState) { 78 | super.onCreate(savedInstanceState); 79 | if (BuildConfig.DEBUG) { 80 | Log.d(UsbSerialTelnetService.TAG, "Creating activity"); 81 | } 82 | setContentView(R.layout.activity_main); 83 | 84 | mStartButton = findViewById(R.id.buttonStart); 85 | mStopButton = findViewById(R.id.buttonStop); 86 | mLocalOnly = findViewById(R.id.switchLocalOnly); 87 | mTcpPort = findViewById(R.id.editTextTcpPort); 88 | mPortId = findViewById(R.id.spinnerPortId); 89 | mBaudRate = findViewById(R.id.editTextNumberBaudRate); 90 | mDataBits = findViewById(R.id.spinnerDataBits); 91 | mStopBits = findViewById(R.id.spinnerStopBits); 92 | mParity = findViewById(R.id.spinnerParity); 93 | mStatus = findViewById(R.id.textViewStatus); 94 | mNoLocalEcho = findViewById(R.id.switchNoLocalEcho); 95 | mRemoveLF = findViewById(R.id.switchRemoveLf); 96 | mAutostart = findViewById(R.id.spinnerAutostart); 97 | 98 | mAutostart.setOnItemSelectedListener(this); 99 | mStartButton.setOnClickListener(this); 100 | mStopButton.setOnClickListener(this); 101 | 102 | Intent serviceIntent = new Intent(this, UsbSerialTelnetService.class); 103 | bindService(serviceIntent, mServiceConnection, 0); // in case if service already started 104 | 105 | updateSettings(); 106 | } 107 | 108 | @Override 109 | protected void onNewIntent(Intent intent) { 110 | // Start service if need 111 | super.onNewIntent(intent); 112 | if (intent == null) return; 113 | SharedPreferences prefs = getApplicationContext().getSharedPreferences(getString(R.string.app_name), Context.MODE_PRIVATE); 114 | String action = intent.getAction(); 115 | if (BuildConfig.DEBUG) { 116 | Log.d(UsbSerialTelnetService.TAG, "Received intent: " + action); 117 | } 118 | 119 | if (isStarted()) { 120 | return; 121 | } 122 | 123 | switch(action) 124 | { 125 | case Intent.ACTION_BOOT_COMPLETED: 126 | case UsbManager.ACTION_USB_DEVICE_ATTACHED: 127 | mNeedClose = prefs.getInt(SETTING_AUTOSTART, AUTOSTART_DISABLED) == AUTOSTART_CLOSE; 128 | /* fall... */ 129 | case UsbSerialTelnetService.ACTION_NEED_TO_START: 130 | break; 131 | default: 132 | return; 133 | } 134 | 135 | switch (UsbSerialTelnetService.getDeviceStatus(this)) { 136 | case NO_DEVICE: 137 | Log.wtf(UsbSerialTelnetService.TAG, getString(R.string.device_not_found)); 138 | return; 139 | case NO_PERMISSION: 140 | Log.e(UsbSerialTelnetService.TAG, getString(R.string.missing_usb_device_permission)); 141 | Toast.makeText(this, R.string.missing_usb_device_permission, Toast.LENGTH_LONG).show(); 142 | return; 143 | case OK: 144 | break; 145 | } 146 | start(); 147 | } 148 | 149 | private void requestDevicePermission(Context context) { 150 | UsbManager manager = (UsbManager) context.getSystemService(Context.USB_SERVICE); 151 | List availableDrivers = UsbSerialProber.getDefaultProber().findAllDrivers(manager); 152 | if (!availableDrivers.isEmpty()) { 153 | UsbSerialDriver driver = availableDrivers.get(0); 154 | UsbDevice device = driver.getDevice(); 155 | Intent intent = new Intent(context, MainActivity.class); 156 | intent.setAction(UsbSerialTelnetService.ACTION_NEED_TO_START); 157 | PendingIntent pendingIntent = PendingIntent.getActivity( 158 | context, 159 | 0, 160 | intent, 161 | PendingIntent.FLAG_IMMUTABLE 162 | ); 163 | manager.requestPermission(device, pendingIntent); 164 | } 165 | } 166 | 167 | @Override 168 | protected void onPause() { 169 | super.onPause(); 170 | saveSettings(); 171 | } 172 | 173 | @Override 174 | public void onClick(View view) 175 | { 176 | switch(view.getId()) 177 | { 178 | case R.id.buttonStart: 179 | mNeedClose = false; 180 | start(); 181 | break; 182 | case R.id.buttonStop: 183 | stop(); 184 | break; 185 | } 186 | } 187 | 188 | @Override 189 | public void onItemSelected(AdapterView parent, View view, int position, long id) { 190 | if (parent.getId() != R.id.spinnerAutostart) return; 191 | SharedPreferences prefs = getSharedPreferences(getString(R.string.app_name), Context.MODE_PRIVATE); 192 | prefs.edit() 193 | .putInt(SETTING_AUTOSTART, position) 194 | .apply(); 195 | } 196 | 197 | @Override 198 | public void onNothingSelected(AdapterView parent) { 199 | // Unused 200 | } 201 | 202 | private void start() { 203 | saveSettings(); 204 | 205 | switch (UsbSerialTelnetService.getDeviceStatus(this)) { 206 | case NO_DEVICE: 207 | Toast.makeText(this, getString(R.string.device_not_found), Toast.LENGTH_SHORT).show(); 208 | return; 209 | case NO_PERMISSION: 210 | requestDevicePermission(this); 211 | return; 212 | default: 213 | break; 214 | } 215 | 216 | Intent ignoreOptimization = prepareIntentForWhiteListingOfBatteryOptimization( 217 | this, getPackageName(), false); 218 | if (ignoreOptimization != null) startActivity(ignoreOptimization); 219 | 220 | Intent serviceIntent = new Intent(this, UsbSerialTelnetService.class); 221 | SharedPreferences prefs = getSharedPreferences(getString(R.string.app_name), Context.MODE_PRIVATE); 222 | serviceIntent.putExtra(UsbSerialTelnetService.KEY_LOCAL_ONLY, prefs.getBoolean(SETTING_LOCAL_ONLY, false)); 223 | serviceIntent.putExtra(UsbSerialTelnetService.KEY_TCP_PORT, prefs.getInt(SETTING_TCP_PORT, 2323)); 224 | serviceIntent.putExtra(UsbSerialTelnetService.KEY_PORT_ID, prefs.getInt(SETTING_PORT_ID, 0)); 225 | serviceIntent.putExtra(UsbSerialTelnetService.KEY_BAUD_RATE, prefs.getInt(SETTING_BAUD_RATE, 115200)); 226 | serviceIntent.putExtra(UsbSerialTelnetService.KEY_DATA_BITS, prefs.getInt(SETTING_DATA_BITS, 3) + 5); 227 | switch (prefs.getInt(SETTING_STOP_BITS, 0)) { 228 | case 0: 229 | serviceIntent.putExtra(UsbSerialTelnetService.KEY_STOP_BITS, UsbSerialPort.STOPBITS_1); 230 | break; 231 | case 1: 232 | serviceIntent.putExtra(UsbSerialTelnetService.KEY_STOP_BITS, UsbSerialPort.STOPBITS_1_5); 233 | break; 234 | case 2: 235 | serviceIntent.putExtra(UsbSerialTelnetService.KEY_STOP_BITS, UsbSerialPort.STOPBITS_2); 236 | break; 237 | } 238 | serviceIntent.putExtra(UsbSerialTelnetService.KEY_PARITY, prefs.getInt(SETTING_PARITY, 0)); 239 | serviceIntent.putExtra(UsbSerialTelnetService.KEY_NO_LOCAL_ECHO, prefs.getBoolean(SETTING_NO_LOCAL_ECHO, true)); 240 | serviceIntent.putExtra(UsbSerialTelnetService.KEY_REMOVE_LF, prefs.getBoolean(SETTING_REMOVE_LF, true)); 241 | if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) { 242 | startForegroundService(serviceIntent); 243 | } else { 244 | startService(serviceIntent); 245 | } 246 | bindService(serviceIntent, mServiceConnection, 0); 247 | } 248 | 249 | private void stop() { 250 | Intent serviceIntent = new Intent(this, UsbSerialTelnetService.class); 251 | stopService(serviceIntent); 252 | mServiceBinder = null; 253 | SharedPreferences prefs = getApplicationContext().getSharedPreferences(getString(R.string.app_name), Context.MODE_PRIVATE); 254 | prefs.edit().putBoolean(UsbSerialTelnetService.KEY_LAST_STATE, false).commit(); 255 | updateSettings(); 256 | } 257 | 258 | private ServiceConnection mServiceConnection = new ServiceConnection() { 259 | @Override 260 | public void onServiceConnected(ComponentName className, 261 | IBinder service) { 262 | mServiceBinder = (UsbSerialTelnetService.ServiceBinder) service; 263 | mServiceBinder.setOnStartStopListener(MainActivity.this); 264 | updateSettings(); 265 | SharedPreferences prefs = getApplicationContext().getSharedPreferences(getString(R.string.app_name), Context.MODE_PRIVATE); 266 | prefs.edit().putBoolean(UsbSerialTelnetService.KEY_LAST_STATE, isStarted()).apply(); 267 | if (BuildConfig.DEBUG) { 268 | Log.d(UsbSerialTelnetService.TAG, "Service connected"); 269 | } 270 | // Close if autoclose enabled 271 | if (isStarted() && mNeedClose) { 272 | // Delay to prevent race condition 273 | mHandler.postDelayed(() -> { 274 | if (mNeedClose) finish(); 275 | }, 1000); 276 | } 277 | } 278 | 279 | @Override 280 | public void onServiceDisconnected(ComponentName componentName) { 281 | mServiceBinder = null; 282 | if (BuildConfig.DEBUG) { 283 | Log.d(UsbSerialTelnetService.TAG, "Service disconnected"); 284 | } 285 | } 286 | }; 287 | 288 | @Override 289 | public void usbSerialServiceStarted() { 290 | } 291 | 292 | @Override 293 | public void usbSerialServiceStopped() { 294 | updateSettings(); 295 | } 296 | 297 | private void saveSettings() { 298 | SharedPreferences prefs = getSharedPreferences(getString(R.string.app_name), Context.MODE_PRIVATE); 299 | int tcpPort; 300 | try { 301 | tcpPort = Integer.parseInt(mTcpPort.getText().toString()); 302 | } 303 | catch (NumberFormatException e) { 304 | tcpPort = 2323; 305 | } 306 | int baudRate; 307 | try { 308 | baudRate = Integer.parseInt(mBaudRate.getText().toString()); 309 | } 310 | catch (NumberFormatException e) { 311 | baudRate = 115200; 312 | } 313 | prefs.edit() 314 | .putBoolean(SETTING_LOCAL_ONLY, mLocalOnly.isChecked()) 315 | .putInt(SETTING_TCP_PORT, tcpPort) 316 | .putInt(SETTING_PORT_ID, mPortId.getSelectedItemPosition()) 317 | .putInt(SETTING_BAUD_RATE, baudRate) 318 | .putInt(SETTING_DATA_BITS, mDataBits.getSelectedItemPosition()) 319 | .putInt(SETTING_STOP_BITS, mStopBits.getSelectedItemPosition()) 320 | .putInt(SETTING_PARITY, mParity.getSelectedItemPosition()) 321 | .putBoolean(SETTING_NO_LOCAL_ECHO, mNoLocalEcho.isChecked()) 322 | .putBoolean(SETTING_REMOVE_LF, mRemoveLF.isChecked()) 323 | .apply(); 324 | } 325 | 326 | private void updateSettings() { 327 | SharedPreferences prefs = getSharedPreferences(getString(R.string.app_name), Context.MODE_PRIVATE); 328 | boolean started = isStarted(); 329 | mStartButton.setEnabled(!started); 330 | mStopButton.setEnabled(started); 331 | mLocalOnly.setEnabled(!started); 332 | mTcpPort.setEnabled(!started); 333 | mBaudRate.setEnabled(!started); 334 | mDataBits.setEnabled(!started); 335 | mStopBits.setEnabled(!started); 336 | mParity.setEnabled(!started); 337 | mNoLocalEcho.setEnabled(!started); 338 | mRemoveLF.setEnabled(!started); 339 | mLocalOnly.setChecked(prefs.getBoolean(SETTING_LOCAL_ONLY, false)); 340 | mTcpPort.setText(String.valueOf(prefs.getInt(SETTING_TCP_PORT, 2323))); 341 | mBaudRate.setText(String.valueOf(prefs.getInt(SETTING_BAUD_RATE, 115200))); 342 | mDataBits.setSelection(prefs.getInt(SETTING_DATA_BITS, 3)); 343 | mStopBits.setSelection(prefs.getInt(SETTING_STOP_BITS, 0)); 344 | mParity.setSelection(prefs.getInt(SETTING_PARITY, 0)); 345 | mNoLocalEcho.setChecked(prefs.getBoolean(SETTING_NO_LOCAL_ECHO, true)); 346 | mRemoveLF.setChecked(prefs.getBoolean(SETTING_REMOVE_LF, true)); 347 | mAutostart.setSelection(prefs.getInt(SETTING_AUTOSTART, AUTOSTART_DISABLED)); 348 | if (started) 349 | mStatus.setText(getString(R.string.started_please_connect) + " telnet://" + (prefs.getBoolean(SETTING_LOCAL_ONLY, false) ? "127.0.0.1" : UsbSerialTelnetService.getIPAddress()) + ":"+ mTcpPort.getText()); 350 | else 351 | mStatus.setText(R.string.not_started); 352 | } 353 | 354 | public static Intent prepareIntentForWhiteListingOfBatteryOptimization(Context context, String packageName, boolean alsoWhenWhiteListed) { 355 | if (Build.VERSION.SDK_INT < Build.VERSION_CODES.M) 356 | return null; 357 | if (ContextCompat.checkSelfPermission(context, Manifest.permission.REQUEST_IGNORE_BATTERY_OPTIMIZATIONS) == PackageManager.PERMISSION_DENIED) 358 | return null; 359 | final WhiteListedInBatteryOptimizations appIsWhiteListedFromPowerSave = getIfAppIsWhiteListedFromBatteryOptimizations(context, packageName); 360 | Intent intent = null; 361 | switch (appIsWhiteListedFromPowerSave) { 362 | case WHITE_LISTED: 363 | if (alsoWhenWhiteListed) 364 | intent = new Intent(Settings.ACTION_IGNORE_BATTERY_OPTIMIZATION_SETTINGS); 365 | break; 366 | case NOT_WHITE_LISTED: 367 | intent = new Intent(Settings.ACTION_REQUEST_IGNORE_BATTERY_OPTIMIZATIONS).setData(Uri.parse("package:" + packageName)); 368 | break; 369 | case ERROR_GETTING_STATE: 370 | case UNKNOWN_TOO_OLD_ANDROID_API_FOR_CHECKING: 371 | case IRRELEVANT_OLD_ANDROID_API: 372 | default: 373 | break; 374 | } 375 | return intent; 376 | } 377 | 378 | public enum WhiteListedInBatteryOptimizations { 379 | WHITE_LISTED, NOT_WHITE_LISTED, ERROR_GETTING_STATE, UNKNOWN_TOO_OLD_ANDROID_API_FOR_CHECKING, IRRELEVANT_OLD_ANDROID_API 380 | } 381 | 382 | public static WhiteListedInBatteryOptimizations getIfAppIsWhiteListedFromBatteryOptimizations(Context context, String packageName) { 383 | if (Build.VERSION.SDK_INT < Build.VERSION_CODES.M) 384 | return WhiteListedInBatteryOptimizations.UNKNOWN_TOO_OLD_ANDROID_API_FOR_CHECKING; 385 | final PowerManager pm = (PowerManager) context.getSystemService(Context.POWER_SERVICE); 386 | if (pm == null) 387 | return WhiteListedInBatteryOptimizations.ERROR_GETTING_STATE; 388 | return pm.isIgnoringBatteryOptimizations(packageName) ? WhiteListedInBatteryOptimizations.WHITE_LISTED : WhiteListedInBatteryOptimizations.NOT_WHITE_LISTED; 389 | } 390 | } 391 | -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 9 | 10 | 21 | 22 | 28 | 29 | 41 | 42 | 53 | 54 | 69 | 70 | 71 | 72 | 80 | 81 | 89 | 90 | 94 | 95 | 99 | 100 | 105 | 106 | 115 | 116 | 129 | 130 | 137 | 138 | 139 | 143 | 144 | 149 | 150 | 159 | 160 | 173 | 174 | 185 | 186 | 187 | 191 | 192 | 197 | 198 | 207 | 208 | 221 | 222 | 230 | 231 | 232 | 236 | 237 | 242 | 243 | 252 | 253 | 266 | 267 | 278 | 279 | 280 | 284 | 289 | 290 | 299 | 300 | 313 | 314 | 322 | 323 | 324 | 328 | 333 | 334 | 343 | 344 | 357 | 358 | 366 | 367 | 368 | 372 | 373 | 378 | 379 | 388 | 389 | 402 | 403 | 411 | 412 | 413 | 417 | 418 | 423 | 424 | 433 | 434 | 447 | 448 | 455 | 456 | 457 | 461 | 462 | 467 | 468 | 477 | 478 | 491 | 492 | 499 | 500 | 501 | 505 | 506 | 511 | 512 | 521 | 522 | 535 | 536 | 544 | 545 | 546 | 550 | 551 | 552 | 553 | 554 | 555 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------