MMM‐Bugsounet - bugsounet/MMM-Bugsounet GitHub Wiki

What MMM-Bugsounet can do, what's this ?

MMM-Bugsounet is an embedded application.

This application is available directly through your browser.

It can be used locally or remotely over the internet.

  • Allows to configure MagicMirror
  • Allows you to create a backup of your configuration file at each modification
  • Displaying Magic Mirror Logs in real time
  • Allows you to do now operations with the embedded Terminal
  • Allows you to manually restart or stop MagicMirror
  • Allows you to turn off or turn on your screen
  • ...

MMM-Bugsounet will always control all plugins, to work in harmony (EXT).

MMM-Bugsounet have a lot of embedded modules

MMM-Bugsounet is required for plugins to work.

You can't using any plugins without main MMM-Bugsounet module

Screenshots of the website

Terminal

Terminal

MagicMirror² Configuration

MMConfig

MMConfig2

Tools Box

Tools

Installation

In MMM-Bugsounet, I have created automatic installer for RaspberryPi and Linux Debian machines. Auto install script will propose to install needed dependencies.

For OSX machines, auto install script is not yet implented. So, manuel installation is nedeed and no help will be given for this

Pre-requirements:

  • MagicMirror v2.31.0 and more
  • MagicMirror² must NOT be installed with sudo command
  • MagicMirror² must be installed according to the magicmirror website (and NOT with any other internet tutorial!)

Requirements:

  • OS:
    • Raspbian 11/12 (Bullseye or Bookworm -- 32-bit Version)
    • Raspbian 12 x64 (Bookworm -- 64-bit Version)
  • RPI 3b+ or more
  • Node: > v23.x.x
  • HD screen (1920x1080) or more

You can't use server mode of MagicMirror² with this module

Auto install (for RaspberryPi or Debian Linux machines only)

cd ~/MagicMirror/modules
git clone https://github.com/bugsounet/MMM-Bugsounet

cd MMM-Bugsounet
npm run setup

Installation Error

npm ERR! code ELIFECYCLE
npm ERR! errno 255
npm ERR! MMM-Bugsounet@setup
npm ERR! Exit status 255
  • Error 255

Error 255 is an error voluntarily generated by MMM-Bugsounet because the installation requirements are not resolved.

Of course, the reason will be given in red above

Configuration

Define your MMM-Bugsounet website configuration

{
  module: "MMM-Bugsounet",
  config: {
    debug: false,
    username: "admin",
    password: "admin",
    useAPIDocs: false,
    useLimiter: true
  }
},

For better security, please don't use default username and password

Option Description Type Default
debug enable or not debug mode Boolean false
username Define your username for login String admin
password Define your password for login String admin
useAPIDocs Display API Docs link in website Boolean false
useLimiter Use http limiter/slowdown on network abuse Boolean true

How Can I connect to MMM-Bugsounet website ?

MMM-Bugsounet website can be open with your browser

You have to know your ip address of your pi !

Samples

With ip address of your pi is 192.168.0.200

Open your browser with this address: http://192.168.0.200:8081

Your browser will open MMM-Bugsounet website :)

Now, just enter your credentials defined in website config ;)

By Reading MMM-Bugsounet logs

MMM-Bugsounet will inform

[LOG]   [Bugsounet] [Web] [Server] Loading Main Server... 
[LOG]   [Bugsounet] [Web] Create website needed routes... 
[LOG]   [Bugsounet] [Web] [Server] Start listening on port 8081 
[LOG]   [Bugsounet] [Web] [Server] Available locally at http://192.168.0.200:8081 
[LOG]   [Bugsounet] MMM-Bugsounet Ready!

Remote Control over the world

With Internet, you can use it in remote too

Just map your prefered incoming port to MMM-Bugsounet port (8081) of your pi !

In this case, you can control MMM-Bugsounet over the world with another internet connexion, or with your phone wherever you are

Docs and Testing API

MMM-Bugsounet have his proper API.

You can consult API docs by enable useAPIDocs: true in your configuration.

You will discover API Docs in MMM-Bugsounet website navbar

Note: This feature is only for testing and developing.

EXT-TelegramBot Commands

/sysinfo

  • description: Show system informations of your system
  • arguments: none | show | hide
  • exemples:
/sysinfo: Sends a summary of the state of your system in Telegram
/sysinfo show: Will display state of your system in MagicMirror²
/sysinfo hide: Will close sysinfo windows of MagicMirror²

/stop

  • description: Stop all running plugins
  • arguments: none
  • exemple:
/stop

/reboot

  • description: Restart your system
  • arguments: none
  • exemple:
/reboot

/shutdown

  • description: Shutdown your system
  • arguments: none
  • exemple:
/shutdown

/close

  • description: Turn off MagicMirror²
  • arguments: none
  • exemple:
/close

/restart

  • description: Restart MagicMirror²
  • arguments: none
  • exemple:
/restart

Update

MMM-Bugsounet is able to update main core and update all installed plugins

cd ~/MagicMirror/modules/MMM-Bugsounet
npm run update

Rebuild

Update and reinstall MMM-Bugsounet when MagicMirror is updated (exemple MagicMirror v2.30.x to v2.31.x)

This command can help also if any problem on MMM-Bugsounet (it's equal to make a complete reinstall of this module)

cd ~/MagicMirror/modules/MMM-Bugsounet
npm run rebuild