EXT‐Volume - bugsounet/MMM-Bugsounet GitHub Wiki

EXT-Volume is a plugins for controling the sound volume level of your mirror

This module is an plugin for MMM-Bugsounet

It can be controled with EXT-TelegramBot or EXT-SmartHome or with some notifications

Screenshot

Installation

Execute npm run setup:EXT-Volume in the MMM-Bugsounet's folder.

cd ~/MagicMirror/modules/MMM-Bugsounet
npm run setup:EXT-Volume

Configuration

To use this module, insert this in the config.js file of MagicMirror.

{
  module: 'MMM-Bugsounet/EXTs/EXT-Volume',
  config: {
    debug: false,
    startSpeakerVolume: 100,
    startRecorderVolume: 50,
    syncVolume: false
  }
},
Option Description Type Default
debug enable or not debug mode Boolean false
startSpeakerVolume Set speaker volume on start in %  number 100
startRecorderVolume Set speaker volume on start in %  number 50
syncVolume Enable sync with system volume control (For multimedia keyboard keys or external mixer using) Boolean false

EXT-TelegramBot command

You can control EXT-Volume with EXT-TelegramBot

Available commands:

  • /volume <number>: change the sound volume level. number is [0 - 100]
  • /mute: mute the speaker
  • /unmute: unmute the speaker
  • /record <number>: change the mic level. number is [0 - 100]

Developer Notes

Incoming notification:

  • Bugsounet_VOLUME-SPEAKER_SET: Set the speaker volume, payload is a number [0 - 100]
  • Bugsounet_VOLUME-SPEAKER_MUTE:
    • With payload true: mute the speaker.
    • With payload false: unmute the speaker
  • Bugsounet_VOLUME-SPEAKER_UP: Will increase speaker volume by 5%
  • Bugsounet_VOLUME-SPEAKER_DOWN: Will decrease speaker volume by 5%
  • Bugsounet_VOLUME-RECORDER_SET: Set the recorder volume (Mic), payload is a number [0 - 100]
  • Bugsounet_VOLUME-RECORDER_UP: Will increase recorder volume by 5%
  • Bugsounet_VOLUME-RECORDER_DOWN: Will decrease recorder volume by 5%

Outgoing notification:

  • Bugsounet_VOLUME-SPEAKER_GET: Get the actual speaker volume level and return it in payload with a number [0 - 100]
  • Bugsounet_VOLUME-RECORDER_GET: Get the actual recorder level and return it in payload with a number [0 - 100]
⚠️ **GitHub.com Fallback** ⚠️