[yamahamusiccast] Initial contribution

CODEOWNERS

@@ -341,6 +341,7 @@
 /bundles/org.openhab.binding.wolfsmartset/ @BoBiene
 /bundles/org.openhab.binding.xmltv/ @clinique
 /bundles/org.openhab.binding.xmppclient/ @pavel-gololobov
+/bundles/org.openhab.binding.yamahamusiccast/ @coop-git
 /bundles/org.openhab.binding.yamahareceiver/ @davidgraeff @zarusz
 /bundles/org.openhab.binding.yeelight/ @claell
 /bundles/org.openhab.binding.yioremote/ @miloit

bom/openhab-addons/pom.xml

@@ -1696,6 +1696,11 @@
       <artifactId>org.openhab.binding.xmppclient</artifactId>
       <version>${project.version}</version>
     </dependency>
+    <dependency>
+      <groupId>org.openhab.addons.bundles</groupId>
+      <artifactId>org.openhab.binding.yamahamusiccast</artifactId>
+      <version>${project.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.openhab.addons.bundles</groupId>
       <artifactId>org.openhab.binding.yamahareceiver</artifactId>

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

@@ -0,0 +1,168 @@
+# Yamaha MusicCast Binding
+
+Binding to control Yamaha models via their MusicCast protocol (aka Yamaha Extended Control).
+With support for 4 zones : main, zone2, zone3, zone4. Main is always present. Zone2, Zone3, Zone4 are read from the model.
+
+UDP events are captured to reflect changes in the binding for
+
+- Power
+- Mute
+- Volume
+- Input
+- Presets
+- Sleep
+- Artist
+- Track
+- Album
+- Album Art
+- Repeat
+- Shuffle
+- Play Time
+- Total Time
+- Musiccast Link
+
+## Supported Things
+
+Each model (AV Receiver, ...) is a Thing (Thing Type ID: yamahamusiccast:device). Things are linked to a Bridge (Thing Type ID: yamahamusiccast:bridge) for receiving UDP events.
+
+## Discovery
+
+No auto discovery
+
+## Thing Configuration
+
+| Parameter          | Type    | Description                                             | Advanced | Required      |
+|--------------------|---------|---------------------------------------------------------|----------|---------------|
+| host               | String  | IP address of the Yamaha model (AVR, ...)               | false    | true          |
+| syncVolume         | Boolean | Sync volume across linked models (default=false)        | false    | false         |
+| defaultAfterMCLink | String  | Default Input value for client when MC Link is broken   | false    | false         |
+
+Default value for *defaultAfterMCLink* is *NET RADIO* as most of the models have this on board.
+
+## Channels
+
+| channel        | type   | description                                                         |
+|----------------|--------|---------------------------------------------------------------------|
+| power          | Switch | Power ON/OFF                                                        |
+| mute           | Switch | Mute ON/OFF                                                         |
+| volume         | Dimmer | Volume as % (recalculated based on Max Volume Model)                |
+| volumeAbs      | Number | Volume as absolute value                                            |
+| input          | String | See below for list                                                  |
+| soundProgram   | String | See below for list                                                  |
+| selectPreset   | String | Select Netradio/USB preset (fetched from Model)                     |
+| sleep          | Number | Fixed values for Sleep : 0/30/60/90/120 in minutes                  |
+| recallScene    | Number | Select a scene (8 defaults scenes are foreseen)                     |
+| player         | Player | PLAY/PAUSE/NEXT/PREVIOUS/REWIND/FASTFORWARD                         |
+| artist         | String | Artist                                                              |
+| track          | String | Track                                                               |
+| album          | String | Album                                                               |
+| albumArt       | Image  | Album Art                                                           |
+| repeat         | String | Toggle Repeat. Available values: Off, One, All                      |
+| shuffle        | String | Toggle Shuffle. Available values: Off, On, Songs, Album             |
+| playTime       | String | Play time of current selection: radio, song, track, ...             |
+| totalTime      | String | Total time of current selection: radio, song, track, ...            |
+| mclinkStatus   | String | Select your Musiccast Server or set to Standalone, Server or Client |
+
+
+| Zones                | description                                          |
+|----------------------|------------------------------------------------------|
+| zone1-4              | Zone 1 to 4 to control Power, Volume, ...            |
+| playerControls       | Separate zone for Play, Pause, ...                   |
+
+## Input List
+
+Firmware v1
+
+cd / tuner / multi_ch / phono / hdmi1 / hdmi2 / hdmi3 / hdmi4 / hdmi5 / hdmi6 / hdmi7 /
+hdmi8 / hdmi / av1 / av2 / av3 / av4 / av5 / av6 / av7 / v_aux / aux1 / aux2 / aux / audio1 /
+audio2 / audio3 / audio4 / audio_cd / audio / optical1 / optical2 / optical / coaxial1 / coaxial2 /
+coaxial / digital1 / digital2 / digital / line1 / line2 / line3 / line_cd / analog / tv / bd_dvd /
+usb_dac / usb / bluetooth / server / net_radio / rhapsody / napster / pandora / siriusxm /
+spotify / juke / airplay / radiko / qobuz / mc_link / main_sync / none
+
+Firmware v2
+
+cd / tuner / multi_ch / phono / hdmi1 / hdmi2 / hdmi3 / hdmi4 / hdmi5 / hdmi6 / hdmi7 / 
+hdmi8 / hdmi / av1 / av2 / av3 / av4 / av5 / av6 / av7 / v_aux / aux1 / aux2 / aux / audio1 / 
+audio2 / audio3 / audio4 / **audio5** / audio_cd / audio / optical1 / optical2 / optical / coaxial1 / coaxial2 / 
+coaxial / digital1 / digital2 / digital / line1 / line2 / line3 / line_cd / analog / tv / bd_dvd / 
+usb_dac / usb / bluetooth / server / net_radio / ~~rhapsody~~ /napster / pandora / siriusxm / 
+spotify / juke / airplay / radiko / qobuz / **tidal** / **deezer** / mc_link / main_sync / none
+
+## Sound Program
+
+munich_a / munich_b / munich / frankfurt / stuttgart / vienna / amsterdam / usa_a / usa_b /
+tokyo / freiburg / royaumont / chamber / concert / village_gate / village_vanguard /
+warehouse_loft / cellar_club / jazz_club / roxy_theatre / bottom_line / arena / sports /
+action_game / roleplaying_game / game / music_video / music / recital_opera / pavilion /
+disco / standard / spectacle / sci-fi / adventure / drama / talk_show / tv_program /
+mono_movie / movie / enhanced / 2ch_stereo / 5ch_stereo / 7ch_stereo / 9ch_stereo /
+11ch_stereo / stereo / surr_decoder / my_surround / target / straight / off
+
+## Full Example
+
+### Bridge & Thing(s)
+
+```
+Bridge yamahamusiccast:bridge:virtual "YXC Bridge" {
+Thing yamahamusiccast:device:Living "YXC Living" [host="1.2.3.4"]
+}
+```
+
+### Basic setup
+
+```
+Switch YamahaPower "" {channel="yamahamusiccast:device:Living:main#power"}
+Switch YamahaMute "" {channel="yamahamusiccast:device:Living:main#mute"}
+Dimmer YamahaVolume "" {channel="yamahamusiccast:device:Living:main#volume"}
+Number YamahaVolumeAbs "" {channel="yamahamusiccast:device:Living:main#volumeAbs"}
+String YamahaInput "" {channel="yamahamusiccast:device:Living:main#input"}
+String YamahaSelectPreset "" {channel="yamahamusiccast:device:Living:main#selectPreset"}
+String YamahaSoundProgram "" {channel="yamahamusiccast:device:Living:main#soundProgram"}
+```
+
+### Player controls
+
+```
+Player YamahaPlayer "" {channel="yamahamusiccast:device:Living:playerControls#player"}
+String YamahaArt "" {channel="yamahamusiccast:device:Living:playerControls#albumArt"}
+String YamahaArtist "" {channel="yamahamusiccast:device:Living:playerControls#artist"}
+String YamahaTrack "" {channel="yamahamusiccast:device:Living:playerControls#track"}
+String YamahaAlbum "" {channel="yamahamusiccast:device:Living:playerControls#album"}
+```
+
+### MusicCast setup
+
+The idea here is to select what device/model will be the master. This needs to be done per device/model which will then be the slave.
+If you want the *Living* to be the master for the *Kitchen*, select *Living - zone (IP)* from the thing *Kitchen*.
+The binding will check if there is already a group active for which *Living* is the master. If yes, this group will be used and *Kitchen* will be added.
+If not, a new group will be created.
+
+*Device A*: Living with IP 192.168.1.1
+*Device B*: Kitchen with IP 192.168.1.2
+
+Set **mclinkStatus** to *Standalone* to remove the device/model from the current active group. The group will keep on exist with other devices/models.
+If the device/model is the server, the group will be disbanded.
+
+```
+String YamahaMCLinkStatus "" {channel="yamahamusiccast:device:Living:main#mclinkStatus"}
+```
+
+During testing with the Yamaha Musiccast app, when removing a slave from the group, the status of the client remained *client* and **input** stayed on *mclink*. Only when changing input, the slave was set to *standalone*. Therefor you can set the parameter **defaultAfterMCLink** to an input value supported by your device to break the whole Musiccast Link in OH.
+
+#### How to use this in a rule?
+
+The label uses the format _Thinglabel - zone (IP)_.
+The value which is sent to OH uses the format _IP***zone_.
+
+```
+sendCommand(Kitchen_YamahaMCServer, "192.168.1.1***main")
+sendCommand(Kitchen_YamahaMCServer, "")
+sendCommand(Kitchen_YamahaMCServer, "server")
+sendCommand(Kitchen_YamahaMCServer, "client")
+```
+
+## Tested Models
+
+RX-D485 / WX-010 / WX-030 / ISX-80 / YSP-1600 / RX-A860 / R-N303D / EX-A1080 / WXA-050 / HTR-4068 (RX-V479)
+MusicCast 20 / WCX-50 / RX-V6A / YAS-306 / ISX-18D / WX-021 / YAS-408

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

@@ -0,0 +1,17 @@
+<?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 http://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.3.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>org.openhab.binding.yamahamusiccast</artifactId>
+
+  <name>openHAB Add-ons :: Bundles :: Yamaha Musiccast Binding</name>
+
+</project>

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

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<features name="org.openhab.binding.yamahamusiccast-${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-yamahamusiccast" description="Yamaha Musiccast Binding" version="${project.version}">
+		<feature>openhab-runtime-base</feature>
+		<feature>openhab-transport-upnp</feature>
+		<bundle start-level="80">mvn:org.openhab.addons.bundles/org.openhab.binding.yamahamusiccast/${project.version}</bundle>
+	</feature>
+</features>

bundles/org.openhab.binding.yamahamusiccast/src/main/java/org/openhab/binding/yamahamusiccast/internal/YamahaMusiccastBindingConstants.java

@@ -0,0 +1,71 @@
+/**
+ * Copyright (c) 2010-2021 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.yamahamusiccast.internal;
+
+import org.eclipse.jdt.annotation.NonNullByDefault;
+import org.openhab.core.thing.ThingTypeUID;
+import org.openhab.core.thing.type.ChannelTypeUID;
+
+/**
+ * The {@link YamahaMusiccastBindingConstants} class defines common constants, which are
+ * used across the whole binding.
+ *
+ * @author Lennert Coopman - Initial contribution
+ */
+@NonNullByDefault
+public class YamahaMusiccastBindingConstants {
+
+    private static final String BINDING_ID = "yamahamusiccast";
+
+    // List of all Thing Type UIDs
+    public static final ThingTypeUID THING_DEVICE = new ThingTypeUID(BINDING_ID, "device");
+    public static final ThingTypeUID THING_TYPE_BRIDGE = new ThingTypeUID(BINDING_ID, "bridge");
+
+    // List of all Channel Type UIDs
+    public static final ChannelTypeUID CHANNEL_TYPE_UID_POWER = new ChannelTypeUID("system:power");
+    public static final ChannelTypeUID CHANNEL_TYPE_UID_MUTE = new ChannelTypeUID("system:mute");
+    public static final ChannelTypeUID CHANNEL_TYPE_UID_VOLUME = new ChannelTypeUID("system:volume");
+    public static final ChannelTypeUID CHANNEL_TYPE_UID_VOLUMEABS = new ChannelTypeUID(BINDING_ID, "volumeAbs");
+    public static final ChannelTypeUID CHANNEL_TYPE_UID_INPUT = new ChannelTypeUID(BINDING_ID, "input");
+    public static final ChannelTypeUID CHANNEL_TYPE_UID_SOUNDPROGRAM = new ChannelTypeUID(BINDING_ID, "soundProgram");
+    public static final ChannelTypeUID CHANNEL_TYPE_UID_SELECTPRESET = new ChannelTypeUID(BINDING_ID, "selectPreset");
+    public static final ChannelTypeUID CHANNEL_TYPE_UID_SLEEP = new ChannelTypeUID(BINDING_ID, "sleep");
+    public static final ChannelTypeUID CHANNEL_TYPE_UID_RECALLSCENE = new ChannelTypeUID(BINDING_ID, "recallScene");
+    public static final ChannelTypeUID CHANNEL_TYPE_UID_MCLINKSTATUS = new ChannelTypeUID(BINDING_ID, "mclinkStatus");
+
+    // List of all Channel ids
+    public static final String CHANNEL_POWER = "power";
+    public static final String CHANNEL_MUTE = "mute";
+    public static final String CHANNEL_VOLUME = "volume";
+    public static final String CHANNEL_VOLUMEABS = "volumeAbs";
+    public static final String CHANNEL_INPUT = "input";
+    public static final String CHANNEL_SOUNDPROGRAM = "soundProgram";
+    public static final String CHANNEL_SELECTPRESET = "selectPreset";
+    public static final String CHANNEL_PLAYER = "player";
+    public static final String CHANNEL_SLEEP = "sleep";
+    public static final String CHANNEL_RECALLSCENE = "recallScene";
+    public static final String CHANNEL_ARTIST = "artist";
+    public static final String CHANNEL_TRACK = "track";
+    public static final String CHANNEL_ALBUM = "album";
+    public static final String CHANNEL_ALBUMART = "albumArt";
+    public static final String CHANNEL_REPEAT = "repeat";
+    public static final String CHANNEL_SHUFFLE = "shuffle";
+    public static final String CHANNEL_MCLINKSTATUS = "mclinkStatus";
+    public static final String CHANNEL_PLAYTIME = "playTime";
+    public static final String CHANNEL_TOTALTIME = "totalTime";
+
+    public static final int CONNECTION_TIMEOUT_MILLISEC = 5000;
+    public static final int LONG_CONNECTION_TIMEOUT_MILLISEC = 60000;
+    public static final String HTTP = "http://";
+    public static final String YAMAHA_EXTENDED_CONTROL = "/YamahaExtendedControl/v1/";
+}