Upgrade

English | Deutsch

Upgrading

⚠️ Read this first if you also run the musiccast adapter

Uninstall the musiccast adapter BEFORE you update. Not afterwards — before.

This adapter replaces musiccast. If both keep running, two adapters talk to the same receiver: both poll it, both switch it, and you end up with two object trees showing different values for the same thing. Delete the musiccast instance in the ioBroker admin, then update.

Which case are you?

You currently run	Go to
yamaha 0.5.x (the old adapter)	Coming from yamaha 0.5.x
musiccast	Coming from musiccast
yamaha 1.x, 2.x or 3.0	Coming from 1.x, 2.x or 3.0

---

Coming from yamaha 0.5.x

What you have to expect

Every datapoint has a new path. Scripts, VIS bindings, Alexa/Google links and history recordings that point at the old paths stop working. This is not a bug you can configure away — the old tree is gone.

You will see six dialogs in a row. The adapter announces every tree change since your version: one each for 1.0.0, 2.0.0, 2.2.0, 2.8.0, 3.0.0 and 3.1.0. Confirm all six. They tell you the same thing this page does.

Your IP address is carried over. The old adapter had one device in its settings; the new one has a device list. The address moves across by itself on the first start — you do not have to type it in again. That row counts as carried over, not as typed: the adapter follows the receiver to a new address and keeps the network search on for it. If you want your list alone in charge, set the network search to Never; deleting the device on its card removes it for good.

The old datapoints are deleted, not left behind. The system folder, the flat zone2/zone3/ zone4 folders and everything under them disappear on the first start. The adapter does not leave orphans lying around.

Do it in this order

1. Write down what you use. Open your scripts and VIS views and note which yamaha datapoints appear in them. This is the only step you cannot do afterwards — once you update, the old tree is gone and you cannot look up what used to be there.
2. Uninstall musiccast, if you have it (see the box at the top).
3. Update the adapter in the ioBroker admin.
4. Wait for the first start. The adapter asks your receiver what it can do, function by function, at the pace the Yamaha specification allows. On a receiver this takes about half a minute. Do not restart it in between.
5. Look at the new tree. Your receiver is now a device node with themed folders. Find the datapoints from step 1 in their new place — see Datapoints.
6. Fix your scripts and views.

Where things went

The old adapter had	Now
everything flat under the instance	one device node per receiver, themed folders below
system.*	split up: model and firmware to info, HDMI to hdmi, speakers to advanced
zone2 · zone3 · zone4	multiroom.zone2 · multiroom.zone3 · multiroom.zone4
one block of playback states per source	ONE player block per zone, showing whatever is playing
Commands · Realtime	gone — the normal datapoints are writable directly

A full walk through the groups is on the Datapoints page.

If you want to go back

Install 0.5.4 again from the ioBroker admin (Adapter list → yamaha → the version dropdown). The new tree stays behind as an orphan; delete the object yamaha.0 in the object browser before you start the old version, otherwise you keep both.

---

Coming from musiccast

musiccast and yamaha are two different adapters with two different namespaces (musiccast.0.… versus yamaha.0.…). There is no automatic takeover, and this adapter never touches the other one — you do the move yourself.

1. Install yamaha and leave the device list empty. The adapter finds MusicCast devices on the network by itself.
2. Check the new tree. Everything your MusicCast device can do appears under yamaha.0.<device>. If your device is also an AV receiver, you now get considerably more than before, because the adapter additionally talks YNCA to it.
3. Move your scripts and views to the new paths — see Datapoints.
4. Delete the musiccast instance. Not before this step, so you can compare, but do not leave it running permanently: two adapters on one device get in each other's way.

Coming from 1.x, 2.x or 3.0

Update normally. The adapter announces each tree change with a dialog and cleans up behind itself. Five changes are worth knowing:

• 2.2.0 — player.elapsedTime and player.totalTime became numbers in seconds. The readable form (1:23) moved to player.elapsedTimeText and player.totalTimeText.
• 2.8.0 — volume now carries the scale your receiver itself displays, and its range is what the receiver accepts. On a MusicCast receiver set to its number display this changes the value: where a script wrote -39, it now writes 41.5. The datapoints actualVolume, actualVolumeMode and inputText are gone; volume and input carry the same information. If your widget expects 0–100, switch on Volume as 0–100 % in the edit dialog of that receiver's card.
• 3.0.0 — every device gets a new object id once: its model and the end of its serial number, for example yamaha.0.rx-v6a-1a2b instead of yamaha.0.Yamaha_RX-V6a or yamaha.0.B_ro. The adapter moves the whole tree by itself — values, recording settings, rooms, functions and aliases go along, and recorded history continues in its old series. A device that is switched off during the update moves at the next start after it has answered; the log names every move. Scripts, VIS views and other adapters that use the old ids need the new ones. Do not go back to 2.x afterwards: 2.x derives the id from the name again, so a found device and a row carried over from the old adapter would get a second, empty tree next to the moved one.
• 3.1.0 — player.playback follows the ioBroker standard: 0 pause, 1 play, 2 stop (until 3.0: 0 play, 1 stop, 2 pause). A script that compares the number needs the new codes; one that presses player.play / pause / stop is not affected. player.source shows the input's name (NET RADIO, Spotify) on MusicCast devices too, where it used to carry MusicCast's id (net_radio).
• 3.3.0 — every datapoint looks the same whichever protocol serves it. sound.adaptiveDrc is a switch (Auto → true; a script that writes Auto keeps working). sleep is a dropdown on every receiver — on a MusicCast-only device it held minutes until now (30 → 30 min). Bass and treble are decibels everywhere. The advanced.inputNames.* datapoints are gone: the input names are the labels of the input dropdown, on every protocol. Zone B's name moves from multiroom.zoneB.name to multiroom.zoneB.zoneName, like every zone's. The first start reads each receiver again, which can take a few minutes per receiver.

Still stuck?

Troubleshooting covers the usual symptoms. If your problem is not there, open an issue with your adapter version, the exact model name and what you see.