node-red-contrib-volumio/node-red-volumio.html

A node library to control Volumio 2 with WebSocket APIs

<script type="text/javascript">
  RED.nodes.registerType('volumio event',{
    category: 'input',
    color: '#93abc3',
    defaults: {
      server: { value: '', type: 'volumio-server' },
      event: { value: 'pushState', required:true}
    },
    inputs: 0,
    outputs: 1,
    icon: 'bridge.png',
    label: function() {
      return this.name || 'volumio event';
    },
    align: 'left'
  });
</script>

<script type="text/x-red" data-template-name="volumio event">
    <div class="form-row">
        <label for="node-input-server"><i class="icon-tag"></i> Server</label>
        <input type="text" id="node-input-server">
    </div>
    <div class="form-row">
        <label for="node-input-event"><i class="icon-tag"></i> Event</label>
        <input type="text" id="node-input-event">
    </div>
    <div class="form-tips">
      <b>Tip:</b> Volumio WebSocket event names can be found here (https://volumio.github.io/docs/API/WebSocket_APIs.html)
      <p>some examples: </p>
      <ul>
          <li>pushState</li>
          <li>connect</li>
          <li>error</li>
          <li>disconnect</li>
          <li>pushState</li>
          <li>pushQueue</li>
          <li>getState</li>
          <li>search</li>
          <li>pushBrowseLibrary</li>
          <li>getBrowseSources</li>
          <li>pushMultiRoomDevices</li>
      </ul>
    </div>
</script>

<script type="text/x-red" data-help-name="volumio event">
    <p>Listen to Volumio2 WebSocket events (https://volumio.github.io/docs/API/WebSocket_APIs.html)</p>

    <h3>Outputs</h3>
    <dl class="message-properties">
        <dt>payload <span class="property-type">object|string</span></dt>
        <dd> Volumio event data</dd>
    </dl>

</script>

<script type="text/javascript">
  RED.nodes.registerType('volumio command',{
    category: 'input',
    color: '#93abc3',
    defaults: {
      server: { value: '', type: 'volumio-server' }
    },
    inputs: 1,
    outputs: 1,
    icon: 'bridge.png',
    label: function() {
      return this.name || 'volumio command';
    },
    align: 'left'
  });
</script>

<script type="text/x-red" data-template-name="volumio command">
    <div class="form-row">
        <label for="node-input-server"><i class="icon-tag"></i> Server</label>
        <input type="text" id="node-input-server">
    </div>
</script>

<script type="text/x-red" data-help-name="volumio command">
  <p>emit a specific command and listen on the corresponding event pushing out the response</p>

  <p>more info on event, data and push event <a href="https://volumio.github.io/docs/API/WebSocket_APIs.html">here</a></p>

    <h3>Inputs</h3>
    <dl class="message-properties">
        <dt>payload.event<span class="property-type">string</span>
        </dt>
        <dd> The event name to emit</dd>
        <dt>payload.data<span class="property-type">string|object</span>
        </dt>
        <dd> The event data</dd>
        <dt>payload.pushEvent<span class="property-type">string (optional)</span>
        </dt>
        <dd> The push event name to listen on</dd>
    </dl>
    <p>some events are pre-mapped and the node will listen on the following list of event ==> pushEvent: </p>
    <ul>
      <li>play ==> pushState</li>
      <li>pause ==> pushState</li>
      <li>prev ==> pushState</li>
      <li>next ==> getSpushStatetate</li>
      <li>setRepeat ==> pushState</li>
      <li>setRandom ==> pushState</li>
      <li>volume ==> pushState</li>
      <li>mute ==> pushState</li>
      <li>unmute ==> pushState</li>
      <li>getQueue ==> pushQueue</li>
      <li>playPlaylist ==> pushQueue</li>
      <li>playFavourites ==> pushQueue</li>
      <li>addToQueue ==> pushState</li>
      <li>getState ==> pushState</li>
      <li>getBrowseSources ==> pushBrowseSources</li>
      <li>browseLibrary ==> pushBrowseLibrary</li>
      <li>getMultiRoomDevices ==> pushMultiRoomDevices</li>
      <li>search ==> pushBrowseLibrary</li>
  </ul>
  <p>however payload.pushEvent will win over internal mapping</p>

    <h3>Outputs</h3>
    <dl class="message-properties">
        <dt>payload <span class="property-type">object|string</span></dt>
        <dd> Volumio event data</dd>
    </dl>


</script>

<script type="text/javascript">
  RED.nodes.registerType('volumio-server',{
    category: 'config',
    defaults: {
      host: { value:'', required: true },
      port: { value: 3000, required: true, validate: RED.validators.number() }
    },
    label: function() {
        return this.host + ':' + this.port ;
    }
  });
</script>

<script type="text/x-red" data-template-name="volumio-server">
    <div class="form-row">
        <label for="node-config-input-host"><i class="icon-tag"></i> Host</label>
        <input type="text" id="node-config-input-host" placeholder="host">
    </div>
    <div class="form-row">
        <label for="node-config-input-port"><i class="icon-tag"></i> Port</label>
        <input type="text" id="node-config-input-port" placeholder="port">
    </div>
</script>