Эта страница является
переводом страницы
Yamaha. Перевод выполнен на 100%.
iRidium for Yamaha
A set of tools to create control interfaces using a driver for Yamaha sound systems.
The documentation was updated on 17.10.2022
Description
iRidium for Yamaha allows to create an interface to control Yamaha sound system. The driver contains a full list of commands and feedback channels that does not require additional setting.
Tested hardware:
- Yamaha wx-021,
- Yamaha wx-051.
Connection
Yamaha driver works via the HTTP protocol. The status becomes online only during data transfer, the rest of the time the status is always offline.
To connect to Yamaha sound system, enter the IP-address of the equipment in the driver settings. If you do not know the IP-address. It can be found by scanning the local network with the help of special software, for example, Advanced Port Scanner.
Driver Setting
1 Enter the Devices tab in a created project and add Yamaha Network driver.
2 Enter connection settings of the driver:
- Log Level - level of logging;
- Host - IP-address of the sound system;
- Port - connection port (by default it is 80);
- Update period - frequency of requests to update data (sec.)
Setting Commands and Feedback Channels
To control equipment it is required to set commands (Commands) and feedback channels (Feedbacks). To send a command, drag'n'drop it on a graphic item and enter a value to send. To display feedback drag'n'drop a feedback channel on a graphic item and choose how to output or display a value.
Read more about work with graphic items in the
"Types of graphic items" article.
The full list of commands and feedback channels is formed inside four types of devices: zone, netusb, tuner and cd. You can add an additional device to the driver, but you can't edit, delete or add an additional command or a feedback channel to a device.
* Preset in the Yamaha driver is a set of parameters set before had to play media files from sources (netusb and tuner).
zone
A zone is a zone where a mediaplayer will play (tuner, CD, netusb). The number of zones depends on equipment. Zone name is the name of a zone (there are 4 zones: main, zone2, zone3, zone4). There must be at least one zone for equipment to work. One zone can work only with one media player at the same time.
Commands
| Name |
Value |
Description
|
| Power |
1 / 0 |
1 - switch to the on-mode,
0 - switch to the standby mode.
|
| Input |
"tuner", "fm", "am", "dab",
"net_radio", "napster", "spotify",
"juke", "qobuz", "tidal", "deezer",
"server", "bluetooth", "mc_link",
"usb", "alexa", "rhapsody",
"amazon_music", "pandora", "siriusxm",
"airplay", "radiko", "aux1", aux2, "digital",
"hdmi1", "hdmi2", "hdmi3", "hdmi4",
"hdmi5", "hdmi6", "hdmi7", "hdmi8",
"hdmi", "av1", "av2", "av3", "av4",
"av5", "av6", "av7". |
Switch the input to...
|
| Volume |
0 ~ 100 |
Control of sound volume in per cent.
|
| Mute |
1 / 0 |
1 - turn on sound in a zone,
0 - turn off sound in a zone.
|
| ApplyPreset |
Value (preset number) |
Use the preset in the zone.
|
| Select Input: Tuner |
|
|
| tuner |
1 |
Switch the input to "tuner" (radio).
|
| Select Input: CD |
|
|
| cd |
1 |
Switch the input to "cd".
|
| Select Input: Netusb |
|
|
| net_radio |
1 |
Switch the input to "net_radio".
|
| napster |
1 |
Switch the input to "napster".
|
| spotify |
1 |
Switch the input to "spotify".
|
| juke |
1 |
Switch the input to "juke".
|
| tidal |
1 |
Switch the input to "tidal".
|
| deezer |
1 |
Switch the input to "deezer".
|
| server |
1 |
Switch the input to "server".
|
| bluetooth |
1 |
Switch the input to "bluetooth".
|
| mc_link |
1 |
Switch the input to "mc_link".
|
| usb |
1 |
Switch the input to "usb".
|
| alexa |
1 |
Switch the input to "Alexa".
|
| rhapsody |
1 |
Switch the input to "rhapsody".
|
| amazon_music |
1 |
Switch the input to "amazon_music".
|
| pandora |
1 |
Switch the input to "pandora".
|
| siriusxm |
1 |
Switch the input to "siriusxm".
|
| airplay |
1 |
Switch the input to "airplay".
|
| radiko |
1 |
Switch the input to "radiko".
|
Feedbacks
| Name |
Value |
Description
|
| Power |
"on" / "standby" |
Work mode (String).
|
| IsOn |
1 / 0 |
Work mode:
1 - on, 0 - standby.
|
| Input |
"tuner", "fm", "am", "dab",
"net_radio", "napster", "spotify",
"juke", "qobuz", "tidal", "deezer",
"server", "bluetooth", "mc_link",
"usb", "alexa", "rhapsody",
"amazon_music", "pandora", "siriusxm",
"airplay", "radiko", "aux1", aux2, "digital",
"hdmi1", "hdmi2", "hdmi3", "hdmi4",
"hdmi5", "hdmi6", "hdmi7", "hdmi8",
"hdmi", "av1", "av2", "av3", "av4",
"av5", "av6", "av7". |
Current input.
|
| IsTuner |
1 / 0 |
Current input:
if "Tuner" - 1, otherwise - 0.
|
| IsNetusb |
1 / 0 |
Current input:
if "Netusb" - 1, otherwise - 0.
|
| IsCD |
1 / 0 |
Current input:
if "CD" - 1, otherwise - 0.
|
| Volume |
0 ~ 100 |
Sound level in per cent.
|
| Mute |
1 / 0 |
"Mute" mode:
1 - sound is on, 0 - sound is off.
|
| Select Input: Tuner |
|
|
| tuner |
1 / 0 |
Current input:
if " tuner" - 1, otherwise - 0.
|
| Select Input: CD |
|
|
| cd |
1 / 0 |
Current input:
if "cd" - 1, otherwise - 0.
|
| Select Input: Netusb |
|
|
| net_radio |
1 / 0 |
Current input:
if "net_radio" - 1, otherwise - 0.
|
| napster |
1 / 0 |
Current input:
if "napster" - 1, otherwise - 0.
|
| spotify |
1 / 0 |
Current input:
if "spotify" - 1, otherwise - 0.
|
| juke |
1 / 0 |
Current input:
if "juke" - 1, otherwise - 0.
|
| tidal |
1 / 0 |
Current input:
if " tidal" - 1, otherwise - 0.
|
| deezer |
1 / 0 |
Current input:
if "deezer" - 1, otherwise - 0.
|
| server |
1 / 0 |
Current input:
if "server" - 1, otherwise - 0.
|
| bluetooth |
1 / 0 |
Current input:
if "bluetooth" - 1, otherwise - 0.
|
| mc_link |
1 / 0 |
Current input:
if "mc_link" - 1, otherwise - 0.
|
| usb |
1 / 0 |
Current input:
if "usb" - 1, otherwise - 0.
|
| alexa |
1 / 0 |
Current input:
if "alexa" - 1, otherwise - 0.
|
| rhapsody |
1 / 0 |
Current input:
if "rhapsody" - 1, otherwise - 0.
|
| amazon_music |
1 / 0 |
Current input:
if "amazon_music" - 1, otherwise - 0.
|
| pandora |
1 / 0 |
Current input:
if "pandora" - 1, otherwise - 0.
|
| siriusxm |
1 / 0 |
Current input:
if "siriusxm" - 1, otherwise - 0.
|
| airplay |
1 / 0 |
Current input:
if "airplay" - 1, otherwise - 0.
|
| radiko |
1 / 0 |
Current input:
if "radiko" - 1, otherwise - 0.
|
netusb
Control of netusb inputs (spotify, napster, usb, etc.).
Commands
| Name |
Value |
Description
|
| Play/Pause |
1 / 0 |
1 - start playing,
0 - stop playing.
|
| Stop |
1 |
Pause playing.
|
| Prev |
1 |
Play the previous track.
|
| Next |
1 |
Play the next track.
|
| FastReverse |
1 / 0 |
1 - start fast reverse,
0 - return to the normal play speed.
|
| FastForward |
1 / 0 |
1 - start fast forward,
0 - return to the normal play speed.
|
| ToggleRepeat |
1 |
Select a repetition mode ("off", "one", "all").
According to the Yamaha protocol, some sources do not support the "Repeat" command.
|
| ToggleShuffle |
1 |
Select a "shuffle" mode ("off", "on", "songs", "albums").
According to the Yamaha protocol, some sources do not support the "Shuffle"" command.
|
| StorePreset |
Value (the number of preset) |
Save the current settings in the preset (the number of the preset > 0).
The settings made earlier will be replaced with the new ones.
According to the Yamaha protocol, sources such as "aux", "AirPlay", "digital" cannot be recorded in the Preset.
|
| Seek |
Value (sec) |
Go to a specific playback position (time is set from the start of playback in seconds).
|
Feedbacks
| Name |
Value |
Description
|
| Input |
"net_radio", "napster", "spotify",
"juke", "qobuz", "tidal", "deezer",
"server", "bluetooth", "mc_link",
"usb", "alexa", "rhapsody",
"amazon_music", "pandora", "siriusxm",
"airplay", "radiko". |
Current input.
|
| PlaybackStatus |
"play", "stop", "pause", "fast_reverse", "fast_forward". |
Play status.
|
| Play |
1 / 0 |
Play status:
if "play" - 1, otherwise - 0.
|
| Pause |
1 / 0 |
Play status:
if "pause" - 1, otherwise - 0.
|
| Stop |
1 / 0 |
Play status:
if "stop" - 1, otherwise - 0.
|
| FastForward |
1 / 0 |
Play status:
if "fast_forward" - 1, otherwise - 0.
|
| FastReverse |
1 / 0 |
Play status:
if "fast_reverse" - 1, otherwise - 0.
|
| RepeatStatus |
"off", "one", "all" |
Repetition mode.
|
| ShuffleStatus |
"off", "on", "songs", "albums" |
"Shuffle" mode.
|
| Track |
"Track" |
Name of a track.
|
| Album |
"Album" |
Name of an album.
|
| AlbumArtUrl |
Image |
A link to an album image.
|
| Artist |
"Artist" |
Performer.
|
| PlayTime |
-59999 ~ 59999 |
Play time (sec.).
|
| PlayTimeStr |
"HH:MM:SS" / "MM:SS" |
Play time (String).
|
| TotalTime |
0 ~ 59999 |
Track time.
|
| TotalTimeStr |
"HH:MM:SS" / "MM:SS" |
Track time (String).
|
tuner
Control of playing radio frequences
Commands
| Name |
Value |
Description
|
| PrevTuner |
1 |
Switch to the previous preset.
|
| NextTuner |
1 |
Switch to the next preset.
|
| SetBand |
"am", "fm", "dab" |
Change radio station.
|
| SetFrequency |
Value |
Set frequency (kHz).
|
| StorePreset |
Value (the number of preset) |
Save the current radio station in the preset (the number of preset > 0).
|
| PrevDabService |
1 |
Switch to the previous digital radio stations (DAB).
|
| NextDabService |
1 |
Switch to the next digital radio station (DAB).
|
| SelectBand |
|
|
| am |
1 |
Switch to "am".
|
| fm |
1 |
Switch to "fm".
|
| dab |
1 |
Switch to "dab".
|
Feedbacks
| Name |
Value |
Description
|
| Band |
"am", "fm", "dab" |
Current station.
|
| Frequency |
Value |
Frequency (kHz).
|
| Preset |
Value |
Number of the current preset (0 - if a preset is not selected).
|
| CurrentBand |
|
|
| am |
1 / 0 |
Current station:
if "am" - 1, otherwise - 0.
|
| fm |
1 / 0 |
Current station:
if "fm" - 1, otherwise - 0.
|
| dab |
1 / 0 |
Current station:
if "dab" - 1, otherwise - 0.
|
cd
Control of playing CDs.
Commands
| Name |
Value |
Description
|
| Play/Pause |
1 / 0 |
1 - start playing,
0 - stop playing.
|
| Stop |
1 |
Pause playing.
|
| Prev |
1 |
Play the previous track.
|
| Next |
1 |
Play the next track.
|
| FastReverse |
1 / 0 |
1 - start fast reverse,
0 - return to the normal play speed.
|
| FastForward |
1 / 0 |
1 - start fast forward,
0 - return to the normal play speed.
|
| ToggleRepeat |
1 |
Select a repetition mode ("off", "one", "all").
|
| ToggleShuffle |
1 |
Select a "shuffle" mode ("off", "on", "songs", "albums").
|
| SetTrackNumber |
1 ~ 512 (the number of a track) |
Select a track numbered...
|
Feedbacks
| Name |
Value |
Description
|
| PlaybackStatus |
"play", "stop", "pause", "fast_reverse", "fast_forward". |
Play status.
|
| Play |
1 / 0 |
Play status:
if "play" - 1, otherwise - 0.
|
| Pause |
1 / 0 |
Play status:
if "pause" - 1, otherwise - 0.
|
| Stop |
1 / 0 |
Play status:
if "stop" - 1, otherwise - 0.
|
| FastForward |
1 / 0 |
Play status:
if "fast_forward" - 1, otherwise - 0.
|
| FastReverse |
1 / 0 |
Play status:
if "fast_reverse" - 1, otherwise - 0.
|
| RepeatStatus |
"off", "one", "all", "folder", "a-b" |
Repetition mode.
|
| ShuffleStatus |
"off", "on", "folder", "program" |
"Shuffle" mode.
|
| Track |
"Track" |
Name of a track.
|
| Album |
"Album" |
Name of an album.
|
| Artist |
"Artist" |
Performer.
|
| PlayTime |
-59999 ~ 59999 |
Play time (sec.).
|
| PlayTimeStr |
"HH:MM:SS" / "MM:SS" |
Play time (String).
|
| TotalTime |
0 ~ 59999 |
Track time.
|
| TotalTimeStr |
"HH:MM:SS" / "MM:SS" |
Track time (String).
|
| DiscTime |
0 ~ 59999 |
CD play time (sec.)
|
| DiscTimeStr |
"HH:MM:SS" / "MM:SS" |
CD play time (String).
|
| TrackNumber |
0 ~ 512 |
The number of a track in the play list
|
| TotalTracks |
0 ~ 512 |
Total number of tracks.
|
