[shieldtv] Initial Contribution - NVIDIA ShieldTV

CODEOWNERS

@@ -298,6 +298,7 @@
 /bundles/org.openhab.binding.serial/ @MikeJMajor
 /bundles/org.openhab.binding.serialbutton/ @kaikreuzer
 /bundles/org.openhab.binding.shelly/ @markus7017
+/bundles/org.openhab.binding.shieldtv/ @morph166955
 /bundles/org.openhab.binding.siemensrds/ @andrewfg
 /bundles/org.openhab.binding.silvercrestwifisocket/ @jmvaz
 /bundles/org.openhab.binding.sinope/ @chaton78

bom/openhab-addons/pom.xml

@@ -1481,6 +1481,11 @@
       <artifactId>org.openhab.binding.shelly</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.openhab.addons.bundles</groupId>
+      <artifactId>org.openhab.binding.shieldtv</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.openhab.addons.bundles</groupId>
       <artifactId>org.openhab.binding.siemensrds</artifactId>

bundles/org.openhab.binding.shieldtv/NOTICE

@@ -0,0 +1,13 @@
+This content is produced and maintained by the openHAB project.
+
+* Project home: https://www.openhab.org
+
+== Declared Project Licenses
+
+This program and the accompanying materials are made available under the terms
+of the Eclipse Public License 2.0 which is available at
+https://www.eclipse.org/legal/epl-2.0/.
+
+== Source Code
+
+https://github.com/openhab/openhab-addons

bundles/org.openhab.binding.shieldtv/README.md

@@ -0,0 +1,98 @@
+# ShieldTV Binding
+
+This binding emulates the Nvidia ShieldTV Android App to interact with an Nvidia ShieldTV for purposes of remote control.
+
+## Supported Things
+
+This binding supports a single thing type:
+
+- **shieldtv** - The ShieldTV
+
+## Discovery
+
+Discovery is not currently part of this binding but is on the roadmap.  This will be updated as updates are committed.
+
+## Binding Configuration
+
+This binding does not require any special configuration files.  
+
+This binding does require a PIN login process (documented below) upon first connection.
+
+## Thing Configuration
+
+There are three required fields to connect successfully to a ShieldTV.
+
+| Name             | Type    | Description                           | Default | Required | Advanced |
+|------------------|---------|---------------------------------------|---------|----------|----------|
+| ipAddress        | text    | IP address of the device              | N/A     | yes      | no       |
+| keystore         | text    | Location of the Java Keystore         | N/A     | no       | no       |
+| keystorePassword | text    | Password of the Java Keystore         | N/A     | no       | no       |
+
+```java
+Thing shieldtv:shieldtv:livingroom [ ipAddress="192.168.1.2" ]
+```
+
+## Channels
+
+| Channel    | Type   | Read/Write | Description                 |
+|------------|--------|------------|-----------------------------|
+| keypress   | String | RW         | Manual Key Press Entry      |
+| pincode    | String | RW         | PIN Code Entry              |
+| devicename | String | RO         | Device Common Name          |
+| app        | String | RW         | App Control                 |
+
+```java
+String ShieldTV_KEYPRESS "KEYPRESS [%s]" { channel = "shieldtv:shieldtv:livingroom:keypress" }
+String ShieldTV_PINCODE  "PINCODE [%s]" { channel = "shieldtv:shieldtv:livingroom:pincode" }
+String ShieldTV_DEVICENAME "DEVICENAME [%s]" { channel = "shieldtv:shieldtv:livingroom:devicename" }
+String ShieldTV_APP "APP [%s]" { channel = "shieldtv:shieldtv:livingroom:app" }
+
+```
+
+KEYPRESS will accept the following commands as strings (case sensitive):
+
+- KEY_UP
+- KEY_DOWN
+- KEY_RIGHT
+- KEY_LEFT
+- KEY_ENTER
+- KEY_HOME
+- KEY_BACK
+- KEY_MENU
+- KEY_PLAYPAUSE
+- KEY_REWIND
+- KEY_FORWARD
+- KEY_POWER
+
+The list above causes an instantanious "press and release" of each button.  
+If you would like to manually control the press and release of each you may append _PRESS and _RELEASE to the end of each.
+(e.g. KEY_FORWARD_PRESS or KEY_FORWARD_RELEASE)
+
+APP will display the currently active app as presented by the ShieldTV.  
+You may also send it a command of the app package name (e.g. com.google.android.youtube.tv) to start/change-to that app.
+
+## Pin Code Process
+
+For the ShieldTV to be successfully accessed an on-screen PIN authentication is required on the first connection.  
+
+To begin the PIN process, send the text "REQUEST" to the pincode channel while watching your ShiledTV.  A 6 digit PIN should be displayed on the screen.
+
+To complete the PIN process, send the PIN displayed to the pincode channel.  The display should return back to where it was originally.
+
+This completes the PIN process.  Upon reconnection (either from reconfiguration or a restart of OpenHAB), you should now see a message of "Login Successful" in openhab.log
+
+
+## Full Example
+
+```java
+Thing shieldtv:shieldtv:livingroom [ ipAddress="192.168.1.2", ]
+```
+
+```java
+String ShieldTV_KEYPRESS "KEYPRESS [%s]" { channel = "shieldtv:shieldtv:livingroom:keypress" }
+String ShieldTV_PINCODE  "PINCODE [%s]" { channel = "shieldtv:shieldtv:livingroom:pincode" }
+String ShieldTV_DEVICENAME "DEVICENAME [%s]" { channel = "shieldtv:shieldtv:livingroom:devicename" }
+String ShieldTV_APP "APP [%s]" { channel = "shieldtv:shieldtv:livingroom:app" }
+
+```
+

bundles/org.openhab.binding.shieldtv/pom.xml

@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/POM/4.0.0"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>org.openhab.addons.bundles</groupId>
+    <artifactId>org.openhab.addons.reactor.bundles</artifactId>
+    <version>3.4.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>org.openhab.binding.shieldtv</artifactId>
+
+  <name>openHAB Add-ons :: Bundles :: ShieldTV Binding</name>
+
+  <dependencies>
+    <dependency>
+      <groupId>org.bouncycastle</groupId>
+      <artifactId>bcpkix-jdk15on</artifactId>
+      <version>1.52</version>
+      <scope>compile</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.bouncycastle</groupId>
+      <artifactId>bcprov-jdk15on</artifactId>
+      <version>1.52</version>
+      <scope>compile</scope>
+    </dependency>
+  </dependencies>
+
+</project>

bundles/org.openhab.binding.shieldtv/src/main/feature/feature.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<features name="org.openhab.binding.shieldtv-${project.version}" xmlns="http://karaf.apache.org/xmlns/features/v1.4.0">
+	<repository>mvn:org.openhab.core.features.karaf/org.openhab.core.features.karaf.openhab-core/${ohc.version}/xml/features</repository>
+
+	<feature name="openhab-binding-shieldtv" description="ShieldTV Binding" version="${project.version}">
+		<feature>openhab-runtime-base</feature>
+		<bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.binding.shieldtv/${project.version}</bundle>
+	</feature>
+</features>

bundles/org.openhab.binding.shieldtv/src/main/java/org/openhab/binding/shieldtv/internal/ShieldTVBindingConstants.java

@@ -0,0 +1,41 @@
+/**
+ * Copyright (c) 2010-2022 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.binding.shieldtv.internal;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.openhab.core.thing.ThingTypeUID;
+
+/**
+ * The {@link ShieldTVBindingConstants} class defines common constants, which are
+ * used across the whole binding.
+ *
+ * @author Ben Rosenblum - Initial contribution
+ */
+@NonNullByDefault
+public class ShieldTVBindingConstants {
+
+    private static final String BINDING_ID = "shieldtv";
+
+    // List of all Thing Type UIDs
+    public static final ThingTypeUID THING_TYPE_SHIELDTV = new ThingTypeUID(BINDING_ID, "shieldtv");
+
+    // List of all Channel ids
+    public static final String CHANNEL_KEYPRESS = "keypress";
+    public static final String CHANNEL_PINCODE = "pincode";
+    public static final String CHANNEL_RAW = "raw";
+    public static final String CHANNEL_RAWMSG = "rawmsg";
+    public static final String CHANNEL_APP = "app";
+    public static final String CHANNEL_DEVICENAME = "devicename";
+    // List of all config properties
+    public static final String IPADDRESS = "ipAddress";
+}

bundles/org.openhab.binding.shieldtv/src/main/java/org/openhab/binding/shieldtv/internal/ShieldTVConfiguration.java

@@ -0,0 +1,36 @@
+/**
+ * Copyright (c) 2010-2022 Contributors to the openHAB project
+ *
+ * See the NOTICE file(s) distributed with this work for additional
+ * information.
+ *
+ * This program and the accompanying materials are made available under the
+ * terms of the Eclipse Public License 2.0 which is available at
+ * http://www.eclipse.org/legal/epl-2.0
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ */
+package org.openhab.binding.shieldtv.internal;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.eclipse.jdt.annotation.Nullable;
+
+/**
+ * The {@link ShieldTVConfiguration} class contains fields mapping thing configuration parameters.
+ *
+ * @author Ben Rosenblum - Initial contribution
+ */
+@NonNullByDefault
+public class ShieldTVConfiguration {
+
+    /**
+     * Sample configuration parameters. Replace with your own.
+     */
+    public @Nullable String ipAddress;
+    public int port = 8987;
+    public int reconnect;
+    public int heartbeat;
+    public @Nullable String keystore;
+    public @Nullable String keystorePassword;
+    public int delay = 0;
+}