Magic Mirror Module that displays your WiFi Network, Password, and QRCode so people who visit your house/business can connect easier.
Note that if you have special characters in your password, the QR code will not work. This is because I haven't done the work required to escape the special characters properly.
- In your terminal, change to your Magic Mirror module directory
`cd ~/MagicMirror/modules`
-
Clone this repository
git clone [email protected]:TeraTech/MMM-WiFiPassword.gitORgit clone https://github.com/TeraTech/MMM-WiFiPassword.git -
Make changes to your
config.jsfile.
As with other MM modules, add this array to the config/config.js file
modules:[
{
module: 'MMM-WiFiPassword',
position: "top_left",
config: {
//See 'Configuration options' for more information.
network: "my_network",
password: "my_pass",
}
},
]
| Option | Description | Default |
|---|---|---|
qrSize |
The width and height of QRCode in pixels. | 125 |
colorDark |
The color of the "dark" area of the QRCode in hex. | #fff |
colorLight |
The color of the "light" area of the QRCode in hex. | #000 |
authType |
Your authentication type. Options are WPA WEP NONE |
WPA |
network |
Your network SSID. | REQUIRED |
password |
Your network Password. | REQUIRED |
hiddenId |
Whether your SSID is hidden. true false |
false |
header |
Custom header text. | Local WiFi Details |
layoutVertical |
Whether to display in vertical (true), or horizontal (false) mode. |
true |
showNetwork |
Show network SSID. true false |
true |
showPassword |
Show your network password. true false |
true |
showAuthType |
Show your authentication type. true false |
true |
debug |
Displays raw QR text. true false |
false |
You can interact with this module with the following notifications:
| Notification | Payload | Description | Requirements |
|---|---|---|---|
WIFIPASSWORD_MODAL |
- | When receiving this notification, the module will Open a modal popup where it shows the QR code. Useful for integrations with touch screens | MMM-Modal |
This module has support for "MMM-Modal". See Notifications above.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent