MMM-Planetarium
MagicMirror Module to display constellations, stars, galaxy, … using VirtualSky Library
Screenshot
- various configurable options.
- real-time live update
- animated auto-panning.
- mouse/keyboard/touch support
MagicMirror Module to display constellations, stars, galaxy, … using VirtualSky Library
“Life is a theatre set in which there are but few practicable entrances.”
― Victor Hugo, Les Misérables
MagicMirror module to change screen scenes by time and order with ANIMATION EFFECT.
The scenario of the MM screen is made up of a series of scenes. Each module has its role in its appearance scenes to enter and exit by design.
When a scene begins, all modules whose roles end, will be expelled, and all modules that have the parts in that scene will be admitted.
As described in the scenario, your MM screen will play a drama with modules.
Old/weak SBCs (e.g. RPI 3 or older) may not have enough power to handle severe animations.
More Details
https://github.com/MMRIZE/MMM-Scenes
Since MM 2.17 (2021-10-01), You can use your MM as Desktop wallpaper (like Rainmeter
of window). Easy.
// in your config.js add these lines.
// (ADDED 2024-05-16) These lines should be placed inside of `config`, not end of file.
// I forgot to mention it because it seemed so obvious. Surprisingly, it seems to be misunderstood as appending these to the end of the file.
electronOptions: {
width: 1920,
height: 1200,
fullscreen: false,
backgroundColor: '#00000000',
titleBarStyle: 'none',
frame: false,
type: 'desktop',
hasShadow: false,
transparent: true,
resizable: false,
},
electronSwitches: ["enable-transparent-visuals"],
That’s all.
python > 3.7
and node-gyp
(It requires Visual Studio
Tools to install).Unlike Mac/Linux, for Windows, you need some hacks for preparation.
cd ~/MagicMirror # Your magicmirror directory
npm install --save electron-wallpaper-napi
# If fails, you might hava some issues about Visual Studio things. Read above;
Then, open js/electron.js
with your editor, and add these two lines;
//around line 7
...
const electron = require("electron");
const core = require("./app.js");
const Log = require("logger");
const electronWallpaper = require('electron-wallpaper-napi') // <-- Insert
// Config
let config = process.env.config ? JSON.parse(process.env.config) : {};
...
and
// around line 50
...
// Create the browser window.
mainWindow = new BrowserWindow(electronOptions);
electronWallpaper.attachWindow(mainWindow) // <-- Insert
...
// in your config.js add these lines.
electronOptions: {
//width: 1920,
//height: 1080,
//x: 0,
//y: 0,
fullscreen: true,
backgroundColor: '#00000000',
frame: false,
type: 'desktop',
transparent: true,
},
electronSwitches: ["enable-transparent-visuals"],
:root {
--color-text: #DDD;
--color-text-dimmed: #BBB;
--color-text-bright: #fff;
--color-background: rgba(0, 0, 0, 0);
/* make fonts color brighter */
--font-size: 2vh;
--font-size-small: 0.75rem;
--gap-body-top: 20px;
--gap-body-right: 120px;
--gap-body-bottom: 20px;
--gap-body-left: 40px;
/* adjust margin for your screen */
}
* {
text-shadow: 2px 2px 5px #000000; /* make text more readable on the background image */
}
replace or add this to contents of your custom.css
Log Extension module for MagicMirror
Many beginners have a problem tracing an unexpected issue when they run the MagicMirror.
Usually, the start of debugging would be to examine backend-log
and frontend-log
but people may have confusing to use both how to.
I know there already exists MMM-Logging
to help with this issue, but it seems not maintained anymore, and I need more features, so I have to re-invent a wheel by myself.
Log
Object) to backend logwindow.error
and unhandledRejection
would be caught then be transmitted to the backendIMPORTANT : This module deliver only
Log.xxx()
to the backend, notconsole.xxx()
.
If your current MM is working without issue, and you don’t really need any new features of the updated version, Don’t update. If the new version still cannot solve your current issue explicitly, Don’t update.
Leave it as it is still being working. Dare to say again, Don’t update
Nevertheless, if you still want to update,
Backup your config/config.js
and css/custom.css
files into somewhere safe.
And you might probably have some additional module-specific resources, like credential JSON, DotEnv(.env) files, or some data feeds/files. Backup them also.
A timeworn OS might need additional or newer dependencies for new MM/modules features.
So you might need to update your OS first. Especially Raspbian or any linux-based OS for SBC, just reinstall from scratch with formatting SD(or MMC). For windows/MacOS, It is less important, so you can ignore this.
If you feel that a fresh reinstall might look somehow too much, at least an update to a recent version might be needed.
NodeJS version and NPM version should be matched with MM’s requirement. Usually, requirements for electron
would be those. (I recommend NVM
to you to manage versions of NodeJS)
Some specific native-node-module
which needs rebuild
(electron-rebuild or node-gyp or something similar) would be affected by these version differences.
Ok, You are a dotard so will not format your RPI, and will not update your environment at all. It is up to you.
If so, at least you’d better install a new MM/modules in another directory, not update the current MM/modules directly.
You can rename the current directory as an insurance. You can restore yours again at any time when you fail with a new version.
Trust me. Installation is easier than updating.
updateNotification
module.Sometimes, not knowing is the solution. Avoid update obsession.
Good luck!
@0m4r
I was the original author of that module. ;)
Basically, if any module could emit any notification and it could be translated properly, it will work.
You can define your customization with payloadConverter
and notification
in config.js
notification: "SOME MODULE NOTI",
payloadConverter:(payload)=>{
return "windy night spring" // <= query text for the image.
}
Currently, this module is managed by brianHelper
MagicMirror module to make monkey-patching other modules
https://github.com/MMRIZE/MMM-ModuleMonkeyPatch
No screenshot, because it works in the background.
When you need some modification of existing modules but do not want to edit the original source code to prevent conflicts on upgrade/update.
But… I think rare people will use this module. :D. This was my half-day weekend killing-time project.
getDom()
, you can override that method with this module.notificationReceived()
with this module.Or many other things, without worrying of update/upgrading the original module on direct modification.
ALL_MODULES_STARTED
notification, which means you cannot override start
method.:::
This is not a request but rather a proposal.
Recently, I rewrote Translator
for my purpose, but if someone has interests, I’ll make a PR to the original repository to share.
Anyway, I need some help; test, proof of concept.
I’m just afraid that I was the only one who needs this. :)
I apologise in advance for a too-long article to read.
:::
This project is rewriting the global Translator object of MagicMirror to have enhanced features.
For several years, the current translator
class works for L10N/I18N of MM successfully. But there is still some lack of features. Especially in the below cases, we need more improvements.
Whenever a new translation by the user is added or updated, translations.js
(core) or .getTranslations()
(module) should be updated and released officially to prevent the update-conflicts issue.
By versioning up, some old translation might be obsoleted or needs to be updated for the change of terms used in MM.
And also, it is hard to add a light-modified custom dictionary like de-au.json
. It would probably be copied from the original de.json
, and even though the difference might be very little, but entire de-au.json
should be published and maintained.
One xx.json
cannot hold several locale-specific translations difference. US English and Australian English are noticeably different from each other from vocabulary to grammar. Some Australian users may prefer "G’day mate"
instead of "Hello"
. Some British people might not be comfortable with the spelling of "Color"
.
English users in Canada(en-CA
) notate dates as 4 September 2021
or September 4, 2021
, And French in Canada(fr-CA
) notate date as 4 septembre 2021
. and the usual numeric format is 2021-09-04
. But in the US(en-US
), people genrally use 09/04/2021
. And in France(fr-FR
) it is 04/09/21
.
German people prefer to write a number like 1.234.567,89
, but in US, it will be 1,234,567.89
. In India, it will be 12,34,567.89
. In China, under ‘hanidec’ numbering format, it will be 一,二三四,五六七.八九
.
Generally, MM module developers have tried to solve these issues by providing specific additional L10N converting by config
. But occasionally it makes another too-many-config-value issue.
And for the date format, we are facing momentJS
deprecation. (Well, luxon
might be the excellent alternative, though.)
Current fallback mechanism - primary language or ‘en’ is not enough. Some people use multi-languages in their country.
Certain Serbian users can speak Serbian, Croatian, Romanian, Hungarian, Slovak, Czech, etc. Anyway English might not be his prefer language. With luck, some modules might provide hu.json
. and some modules might provide hr.json
. But he should select only one language for his Mirror. And whatever he chooses, other modules will display English. Of course, en
must be the last-final-safe fallback. However, it will be convenient and user-friendly if MM provided more steps before the final solution.
Also, there could be cases like this; sometimes fr-CA
user needs fr-CA
translation at first, then want to use familiar fr
, then en-CA
if available, at last reluctantly use standard en
as final fallback.
translator
is not a template engine. However, if it could handle Object
and Array
it would provide more abundant natural translation results. In some counties, the first name is preferred to Family name, and in some countries, vice versa. If translator
can handle user: {firstName, familyName, gender, title}
together instead of addressing each userFirstName
, userFamilyName
, userGender
, userTitle
, it could reduce the codes and make meaningful context.
Customizable value-formatters would be a help for L10N/I18N also. A Module developer needs to support only general value and format, and then a translation provider could convert that value to another format with those formatter on dictionaries.
For example; Instead of "Unread mail: 3"
, more natural sentences "There is a mail unread."
, "There are 3 mails unread."
or "Es gibt eine ungelesene Mail."
, "Es sind 3 Mails ungelesen"
could be possible with some formatters and language/locale information by translation provider, not by module developer himself.
Finally, translation could be used as a light template engine with those features. It will give more freedom to the user who wants to customize the MM.
Those are the main reason what this project begins.
// in `config.js`
language: "fr-CH",
languages: ["it", "de-CH"],
locale: "fr-CH",
config.languages
are proposed. You can define multi-languages to use by preferred order.
For backward compatibility, config.language
would still be used. config.language
will be regarded as a primary language. In above example, this configuration is same with languages: ["fr-CH", "it", "de-CH"]
. (translator
itself doesn’t refer config.language
but other modules might be using it.)
For convenience, config.languages: "it, de-CH"
would also be allowed.
"en-CA"
or "en-ca"
would be suitable for language code. But don’t use "en_CA"
. Ithe t is not standard BCP-47 format.
Each locale-like language code implies to refer its ancestor dictionaries. "fr-CH"
will use fr-ch.json
and fr.json
. When translator cannot find the term in the fr-ch.json
, it will try to seek from fr.json
. Another case; zh-Hans-HK
will try zh-hans-hk.json
then zh-hans.json
, then zh.json
(and finally en.json
, of course). But zh-hant.json
or zh-tw.json
will not be referred.
So, in the above case, the translator
will refer to dictionaries by order - fr-ch
, fr
, it
, de-ch
, de
and the final implied fallback en
.
If the translator
cannot find any term or dictionary in module’s /translations
, it will try MM’s /translations
(core). If nothing is matched in the end, null
or runtime fallback message
(from .translate()
) would be returned.
So you can extend your sub-dictionary easily. If you already have a complete dictionary - de.json
, you can make de-au.json
without copying whole terms. Just describe exclusive terms only being different with de.json
. All other unmentioned terms in de-au.json
will be referred from de.json
automatically.
locale
would be needed. If not described, default
would be used in translator
, and it would generally infer your default system locale.
For backward compatibility; same naming rule with current lower capitalized BCP-47 format. (e.g. en.json
, en-ca.json
)
By the way, current MM’s translations files are not fully fitted for BCP-47.
kr.json
should beko.json
, etc…
For developer; You don’t need to maintain translations.js
or .getTranslations()
. Needed translation files that exist in /translations
directory will be loaded automatically by the user’s configuration.
For backward compatibility; same syntax with current - "TERMS" : "DEFINITION"
is still used. (e.g. { "SAY_HELLO" : "Hello, {userName}!" }
)
(new) Nested Object/Array index is usable. (e.g. { "SAY_HELLO" : "Hello, {user.0.name} and {user.1.name}!" }
)
(new) pre-defined or custom formatter is usable. Formatter symbol is @
. (e.g. { "TIME_INSTANT" : "It's {now@myTime}" }
). Variable now
will be converted to specific format by definition of @myTime
formatter defined in translation dictionary.
(new) Definition of formatter could be added. Translation file provider can adjust options to format the variable replacements for his language/locale.
Drawback; Dynamic loading translation files on runtime could spit out dev-console 404 error messages, because translator doesn’t know that every translations exist or not. Error messages make no harm and they are ignorable, but annoying anyway.
Example
// in MM-Something module
var translated = this.translate("TIME_INSTANT", { now: new Date() });
// => It's Monday, 9 in the morning.
/* modules/MM-Something/translations/en.json */
{
"SAY_HELLO": "Hello, {user.name}!",
"TIME_INSTANT": "It's {now@myTime}.",
"@myTime": {
"format": "DateTimeFormat",
"options": { "dayPeriod": "short", "hour12": true, "weekday": "long", "hour": "numeric" }
}
}
/* modules/MM-Something/translations/de.json */
{
"SAY_HELLO": "Hallo, {user.name}!",
"TIME_INSTANT": "Es ist {now@myTime}.",
"@myTime": {
"format": "DateTimeFormat",
"options": { "dateStyle": "long", "timeStyle": "short" }
}
}
With locale = "en-US"
and language = "en"
, translated result will be It's Monday, 9 at night.
With locale = "de-DE"
and language = "de"
, translated result will be Es ist 6. September 2021 um 21:09.
As it shows, module developer doesn’t need to preserve every available conversion result. Translator maker could format it by himself for his locale and language.
(module).translate(key [, variablesObject][, fallbackMessage][, asObject])
key
{string} (required) terms identifier to translate.variableObject
{object} (optional) replacement values as object.fallbackMessage
{string} (optional) fallback message.asObject
{boolean} (optional) return translated result as object
instead string
. When you need more info about translated result, set this to true
.Each optional values are omittable.
this.translate("SAY_HELLO");
this.translate("SAY_HELLO", true);
this.translate("SAY_HELLO", { name: "Tom" });
this.translate("SAY_HELLO", { name: "Tom" }, true);
this.translate("SAY_HELLO", "Hello, nobody");
this.translate("SAY_HELLO", "Hello, nobody", true);
this.translate("SAY_HELLO", { name: "Tom" }, "Hello, nobody");
this.translate("SAY_HELLO", { name: "Tom" }, "Hello, nobody", true);
Return value will become a translated result with the variables. When translations would be failed(not found terms in all the dictionaries, some error causing, invalid variables, etc.)
When asObject
set as true
, the return object would have these properties;
{
key, // original seeking term
variables, // replacement
asObject, // return value as object or string
language, // which language is used
source, // translation template before replacement with variables
translated, // final translated result
criteria, // where the dictionary locates ('core' or each module)
fallback, // fallback message from `.translate()`
moduleName, // which module call this
toString(); // toString method. return value will be same with `translated`
}
In general module developing, this.translate()
might be waht all you need to know. But for more control of translator
, you can use the below methods.
Translator.getLanguages()
It will return current array of language list used in Translator by seeking order. Usually it will be a combination mix of config.language
and config.languages
.
Translator.getLocale()
It will return current locale value. Usually it will be a BCP-47 regulated config.locale
. When the user’s locale info is not proper, it will have default
as a default value.
Translator.registerFormatter(formatName, formatFunc)
formatName
{string} (required) format identifierformatFunc
{Function} (required) callback function to format value.
formatFunc
will get a format object as a parameter when it called.{
value, // original value from replacement variables to format by this formatter
locale, // If not described in dictionary, default locale value of translator will be used
...rest // all other values of user definition in dictionary
}
With this method, you can add or overwrite global formatter from your module.
Example
// in MM-Something module.
Translator.registerFormatter("TemperatureConverter", function ({ value, locale, options } = {}) {
if (isNaN(value)) return value;
if (locale === "en-US") {
// // just for example of how to use locale.
options.unit = "°F";
options.convert = "c2f";
}
var unit = options.unit ? options.unit : "";
if (options.convert) {
if (options.convert.toLowerCase() === "c2f") return Math.round((value * 9 * 10) / 5) / 10 + 32 + unit;
if (options.convert.toLowerCase() === "f2c") return Math.round(((value - 32) / 9) * 5 * 10) / 10 + unit;
}
return value + unit;
});
// ...
var translated = this.translate("CURRENT_TEMP", { temp: 22 });
// It will have 'It is 71.6°F.' as defined in dictionary.
/* in translation file */
{
"CURRENT_TEMP": "It is {temp@myTemp}.",
"@myTemp": {
"format": "TemperatureConverter",
"options": { "unit": "°F", "convert": "c2f" }
/* "locale": "en-US" */
}
}
Regardless of whatever original locale is, translation provider can set locale to be used frocely for fromatting in this translation when he sets
locale
.
NumberFormat
Implementation of Intl.NumberFormat
- more info
You can change the number values to various formats for the locale - currency, unit, conversion, separtor grouping, aproximation, etc. See above link.
number
or calculable data (e.g. stringified number - “123”)options
, locale
Examples of what possible
DateTimeFormat
Implementation of Intl.DateTimeFormat
- more info
You can change the date values to various formats for the locale - various calendar/date/time/timezone and misc. parts.
Date
object or date-like data (e.g. stringified date - “2021-08-19 12:34:56”)options
, locale
Examples of what possible
RelativeTimeFormat
Implementation of Intl.RelativeTimeFormat
- more info
You can convert period to relative humanized format by unit.
number
or calculable data (e.g. stringified number - “123”) as periodoptions
, locale
, unit
Examples of what possible
RelativeTimeFormat
needs baseunit
to calculate.AutoScaledRelativeTimeFormat
will auto calculate unit for convenience. See below.
AutoScaledRelativeTimeFormat
Similar to RelativeTimeFormat
but unit
will be decided automatically. The period is calculated based on the current time.
Date
object or date-like data (e.g. stringified date - “2021-08-19 12:34:56”)options
, locale
ListFormat
Implementation of Intl.ListFormat
- more info
You can list items with language-sensitive list formatting.
array of string
options
, locale
Examples of what possible
PluralRules
Implementation of Intl.PluralRules
- more info
It enables plural-sensitive formatting and plural-related language rules.
number
or calculable data (e.g. stringified number - “123”)options
, locale
, rules
Examples of what possible
/* in translation xx.json */
{
"I_HAVE_BALL": "I have {count} ball{count@plural_postfix_s}.",
"@plural_postfix_s": {
"format": "PluralRules",
"options": { "type": "ordinal" },
"rules": {
"one": "",
"other": "s"
}
}
}
Select
Simple conditional value converter
string
rules
/* in translation xx.json */
{
"STATUS": "Main job is {status@mySelect}.",
"@mySelect": {
"rules": {
"ONGOING": "processing now",
"STOP": "stopped",
"FINISH": "completed",
"other": "working"
}
}
}
When this formatter cannot find the matched rule with given value, "other"
will be used.
this.translate("STATUS", { status: "ONGOING" });
// => 'Main job is processing now.'
this.translate("STATUS", { status: "PREPARED" });
// => 'Main job is working.'
based on MM 2.16 dev (2.17 beta).
All spec. described above is implemented.
new Unit Test for translator is written and is passed.
unit test : jest tests/unit/classes/translator_spec.js -i --forceExit
I haven’t made PR to main MM repository, because;
(TODO) e2e test. > but I have no idea how to build it. I need a help.
(TODO) Documentation > new trnaslator
probably need a documentation for the users. I need a help too, because I’m not a native English user so my skill of writing is not enough.
(TODO maybe) Sharing translator for node_helper
To this moment, I’m not sure whether this project has worthy to be included in main MM project or not. Will this be useful? I’m afraid that I’m the only one who needs these enhanced feature.
Thanks.
Seongnoh Yi (eouia0819@gmail.com)
My desktop clock? calendar? whatever…
with some modules modification and scripts, it could become a 9to5 office gadget.
I need some more angled plugs for a better look, anyway 90% done.
@flemmingss
I’m trying to build a new X3 from the scratch, which will respect default MM’s behaviours, will be independent of legacy/external momentJs
or other 3rd parties, will be more modular and lighter than X2 and with a few new features.
But it needs more days or weeks to release. I wish I have more dedicated time to that work. Sorry.
@MMrustykayn66
Only Google calendars are affected? How about other calendar? Like the default sample calendar?
@czabel
Well, that is not the bug, however you might be uncomfortable.
It is designed to get the symbol from the first
(internally structured) event of the calendar group.
Because the default calendar module will broadcast only the events themselves, not the meta-information from the calendar to which the event belonged, So there is no easy way to distinguish the default symbol
of the specific calendar.
To be honest, getting the default
symbol from config
of ONLY the default calendar
module might be easy, but this module is designed to take events from any other possible modules, so I cannot assume all the user will get the events from the default calendar
module only.
Not so easy. Has somebody any idea?
@odin_greythorn
I need the front-end log for checking.
You can get the front-end log by;
Ctrl
+Shift
+I
to open front dev console on the running, or,npm run start:dev
command, or,MMM-LogExt
module to deliver front-end logs to the backend.@czabel said in MMM-CalendarExt3:
Do you have any insight as to how to change my CSS to get the icons to show up for every event? As I mentioned, my current setup makes my non-fullday events colored in, but this deletes the icon. The icon is still there for the real fullday events. I’d like to keep the icon, if at all possible. Thank you!
Sorry for the late reply. I was on vacation.
Append these codes to your custom.css
/* custom.css */
.CX3 .event.singleday .headline.useSymbol .symbol {
color: var(--oppositeColor);
}
@veny
I’m not supporting CX2* anymore, You may need to use CX3Agenda.
https://github.com/MMRIZE/MMM-CalendarExt3Agenda
@odin_greythorn said in MMM-CalendarExt3 Not showing on some clients:
The pi setup is a bit weird - I am running fullpageos as the image (based on bullseye I think) and the attached display is a salvaged laptop screen with an ebay display driver board. I couldn’t get regular kiosk mode to work at all for this setup, which prompted me to try out this image
Which browser are you using in the PI? Tell us your environment exactly.
@czabel
I’m in holidays this week. I’ll show you next week.
@czabel said in MMM-CalendarExt3:
Thank you for the eventTransformer fix - is there some ruleset I can find for other icons, or just prefix everything with “fas”?
“fa-solid” will work too, instead of “fas”. I think you may did some typo mistake somewhere.
As for the other, you are right that I have edited the eventHeight, in order to grow the size of the whole calendar. Is there a better way to do this? Perhaps I should be using only the maxEventLines to grow the size of things?
Generally, eventHeight
and maxEventLines
could control the height of the view, Anyway you may need additional CSS modification to beautify the view.
Original
APPLIED
{
module: "MMM-CalendarExt3",
position: "bottom_bar",
config: {
eventHeight: "30px",
fontSize: "22px",
}
},
I guess you may also incline fontSize
. That property will be applied to all the elements . So all text would be bigger. but not the padding or margin or other attributes of the element. That’s why your view looked so weird. So you have to adjust other things with CSS to harmonize your view.
{
module: "MMM-CalendarExt3",
position: "bottom_bar",
config: {
eventTransformer: (ev) => {
if (ev.title.includes("Volleyball")) {
ev.symbol = ["fas fa-fw fa-volleyball"]
}
return ev
}
}
},
Due to most weird format of the default calendar symbol descriptor, you should write something like ["fas fa-volleyball"]
About the height of the event cell, I think you have modified some CSS or eventHeight
property in the config.
@czabel
I need your config and custom.css to guess what happened.