Code Monkey home page Code Monkey logo

magicmirror-documentation's Introduction

title
Introduction

MagicMirror²: The open source modular smart mirror platform.

License GitHub Actions Build Status CodeCov Status

MagicMirror² is an open source modular smart mirror platform. With a growing list of installable modules, the MagicMirror² allows you to convert your hallway or bathroom mirror into your personal assistant. MagicMirror² is built by the creator of the original MagicMirror with the incredible help of a growing community of contributors.

MagicMirror² focuses on a modular plugin system and uses Electron as an application wrapper. So no more web server or browser installs necessary!

MagPi Top 50

magicmirror-documentation's People

Contributors

alvinger avatar andypoms avatar b1gg avatar bkeyport avatar bryanzzhu avatar bugsounet avatar buxxi avatar cfenner avatar cospeedster avatar crazylegstoo avatar cristian-tudorache avatar cweinhofer avatar dependabot[bot] avatar dwoolridge avatar earlman avatar eouia avatar khassel avatar kristjanesperanto avatar magmar94 avatar michmich avatar paulsp avatar radokristof avatar rejas avatar rushilwiz avatar skysails avatar sti2nd avatar tderflinger avatar theduffman85 avatar tom-hirschberger avatar xbcreepinjesus avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

magicmirror-documentation's Issues

Problem with manual installation instructions

Why do the manual installation instructions direct the user to install the latest version 10.x of node when "npm does not support Node.js v10.15.2"?

For a noob, trying to follow these instructions in 2020, they are completely unusable and lead to a dead-end

add this picture to docs (possibly in a new section)

add this info to docs from forums:


In case one wants to know where the various regions are. Missing are the fullscreen_below and fullscreen_above as those cover the whole screen, one under everything else and the other above.

top_bar and bottom_bar are light gray
top_left and bottom_left are red
top_center and bottom_center are blue
top_right and bottom_right are green
upper_third is yellow
middle_center is cyan
lower_third is magenta

All these regions will resize as needed.

magicmirrorregions

./development/node_helper.md line 115

Hi,

I'm new to the MagicMirror community. I was reading the docs and got confused by line 115 in node_helper.md

It stated the following:
"If you want to send a notification to all your modules, use the sendSocketNotification(notification, payload)"

Doesn't sendNotification(notification, payload) send notifications to all modules and sendSocketNotification(notification, payload) send notifications between node_helper.js and your module?

Thanks!

fieldname for ApiKey

the fielddname for the Api Key is changed and gives problems while migrating from the previous version

Documentation correction for default weather module

On https://docs.magicmirror.builders/modules/weather.html, in the Configuration Options section, under 'UK Met Office (ukmetoffice) options', for the 'apiBase' config option, the 'possible value' displayed is not correct.

The URL displayed starts with https, when it should be http. Using https results in a CORS error, whilst using http results in the weather being displayed as it should.

Note that corroberating information can be found in the overview section at: https://www.metoffice.gov.uk/services/data/datapoint/api-reference

Platform: Raspberry Pi 4
Node Version: 20.0.0
MagicMirror² Version: 2.25.0
My Working Configuration:

{
		module: "weather",
		position: "top_right",
		config: {
				apiBase: "http://datapoint.metoffice.gov.uk/public/data/val/wxfcs/all/json/",
				locationID: 324240,
				apiKey: "SENSITIVE INFO REMOVED",
				weatherProvider: "ukmetoffice",
				type: "daily",
				roundTemp: true,
				degreeLabel: true,
				updateInterval: 21600000, // 21600000 = 6 hours
				showPrecipitationProbability: true
		}
}

Only 2 day's forcast is displayed

Hi,

I am new to the MagicMirror with limited coding back ground.
My Weather forcat module is showing only 2 day's forcast irrespectve of the value set in 'maxNumberofDays'

The Module was working perfectly before I updated the latest MagicMirror Version.

WeathFC
WeathFCconfig

Module/Weather/windUnits>>wrong Description

Hi!

I haven't tried to change It, because i don't know how...:

In the Documentation of the Weather Module in "WindUnits" it seems to be the wrong units declared: Fahrenheit and Celsius... ?

Can anyone fix it?

Greetings

defaultSymbol and fa library versions.

defaultSymbol links to https://fontawesome.io/icons/ which gives page not found error.
Also, latest MM update (Apr '22) changes fa library version, possibly causing icons to no longer load.
e.g., fa-calendar-check-o (fa v4) no longer works.
Backward compatibility ought to be implemented to accommodate older fa library versions.
Instructions need to be fa library version specific.

Request: List of environment variables for documentation purposes

The recent issue with misquoting how to use an environment variable makes me curious - what variables are available, and how are they used? I'd like to develop out documentation on how to use them, etc. I've been thinking of working on the documentation somewhat, and this seems like a good place to start.

Update installation for hardware specs

Could you provide some details or resources as to what will be required on hardware side to achieve this.
For eg. i had to google a lot to understand that ill need some sort of display, a two way mirror, maybe a window frame and ofcourse a rasberry pie which you already mentioned.

Missing Docs

No, no I don't forget !

I have to write 2 news Docs for v2.26

  • calendar: updateOnFetch feature
  • updatenotification: updates , updateTimeout, updateAutorestart

I will write it as soon as possible, sorry i'm busy actually

Newsfeed shows description, newsfeed displays loading regardless of hideLoading: true.

Hi my newsfeed module worked brilliantly for the last two years. I just updated my MagicMirror without editing the config.js and now I bump into problems....

Setup: Mirror has 2 newsfeed bars (one for MAJOR events in my case NL-alert and amber-alert. This bar is setup to only show for 1 hour if something serious is going on locally. The second newsfeed bar has "regular" news. The RSS still work, but I prefer my mirror nice and tidy. So just the headlines and no description. Below is the config.js and a screenshot....

It seems bar 1 does not listen to "hideLoading" anymore.
Bar 2 seems not to listen to "showDescription"=false Although I admit I added that line in the config.
Id just like the headlines and not the newsarticle description with it.

Could anyone help please? pretty please with cherry on top. Updated via git pull && npm install.

BAR1:

{
module: "newsfeed",
position: "top_bar",
config: {
hideLoading: true,
ignoreOldItems: true,
ignoreOlderThan: 6000000,
// // The config property is optional.
// // If no config is set, an example calendar is shown.
// // See 'Configuration options' for more information.

		feeds: [
			{
				title: "NL Alert / Rijnmond veiligheidsregio",
				url: "https://rss.rijnmondveilig.nl/rotterdamrijnmond/index.rss",
			},
			{
				title: "NL Alert / Rijnmond veiligheidsregio",
				url: "https://crisis.nl/algemene-informatie-van-crisisnl/",
			},

// {
// title: "Leonidas",
// url: "https://twitrss.me/twitter_user_to_rss/?user=@RKSV_Leonidas",
// },
// {
// title: "Sky News",
// url: "http://feeds.skynews.com/feeds/rss/world.xml",
// },
// {
// title: "AD Rotterdam",
// url: "https://www.ad.nl/rotterdam/rss.xml",
// },
]
},
},

BAR2

{
module: "newsfeed",
position: "top_bar",
config: {
hideLoading: true,
showDescription: false,
updateInterval: 7000,
// The config property is optional.
// If no config is set, an example calendar is shown.
// See 'Configuration options' for more information.

		feeds: [
			{
				title: "NU",
				url: "http://www.nu.nl/rss/Algemeen",
			},
			{
				title: "RTE",
				url: "https://www.rte.ie/feeds/rss/?index=/news/&limit=20",
			},

// {
// title: "Leonidas",
// url: "https://twitrss.me/twitter_user_to_rss/?user=@RKSV_Leonidas",
// },
{
title: "Sky News",
url: "http://feeds.skynews.com/feeds/rss/world.xml",
},
// {
// title: "Rijnmond",
// url: "https://wwww.rijnmond.nl/rss",
// },
]
},
},

Schermafbeelding 2021-03-17 om 00 27 34

Manual install - bad directions soon....

bkeyport@officemirror:~$ curl -sL https://deb.nodesource.com/setup_18.x | sudo -E bash -

================================================================================
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓

                       SCRIPT DEPRECATION WARNING                    

This script, located at https://deb.nodesource.com/setup_X, used to
install Node.js is deprecated now and will eventually be made inactive.

Please visit the NodeSource distributions Github and follow the
instructions to migrate your repo.
https://github.com/nodesource/distributions

The NodeSource Node.js Linux distributions GitHub repository contains
information about which versions of Node.js and which Linux distributions
are supported and how to install it.
https://github.com/nodesource/distributions

                      SCRIPT DEPRECATION WARNING

================================================================================
▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓▓

TO AVOID THIS WAIT MIGRATE THE SCRIPT
Continuing in 60 seconds (press Ctrl-C to abort) ...

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.