{"id":13830544,"url":"https://github.com/TeraTech/MMM-WiFiPassword","last_synced_at":"2025-07-09T11:33:24.608Z","repository":{"id":45176418,"uuid":"220857102","full_name":"TeraTech/MMM-WiFiPassword","owner":"TeraTech","description":"Magic Mirror Module that displays your WiFi network, password with QRCode","archived":false,"fork":false,"pushed_at":"2024-02-11T16:14:34.000Z","size":45,"stargazers_count":99,"open_issues_count":7,"forks_count":19,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-08-04T10:03:20.434Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TeraTech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-10T22:01:57.000Z","updated_at":"2024-08-04T10:03:23.289Z","dependencies_parsed_at":"2024-08-04T10:13:26.967Z","dependency_job_id":null,"html_url":"https://github.com/TeraTech/MMM-WiFiPassword","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeraTech%2FMMM-WiFiPassword","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeraTech%2FMMM-WiFiPassword/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeraTech%2FMMM-WiFiPassword/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TeraTech%2FMMM-WiFiPassword/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TeraTech","download_url":"https://codeload.github.com/TeraTech/MMM-WiFiPassword/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225539434,"owners_count":17485327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T10:01:01.802Z","updated_at":"2024-11-20T11:30:56.035Z","avatar_url":"https://github.com/TeraTech.png","language":"JavaScript","funding_links":[],"categories":["Network"],"sub_categories":[],"readme":"# MMM-WiFiPassword\nMagic Mirror Module that displays your WiFi Network, Password, and QRCode so people who visit your house/business can connect easier. \n\nNote 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. \n\n## Screenshot\n\n![MMM-WifiPassword Screenshot](https://raw.githubusercontent.com/TeraTech/MMM-WiFiPassword/master/mm.png)\n\n\n## Installation\n  1. In your terminal, change to your Magic Mirror module directory\n\n    `cd ~/MagicMirror/modules`\n  \n  2. Clone this repository `git clone git@github.com:TeraTech/MMM-WiFiPassword.git` OR `git clone https://github.com/TeraTech/MMM-WiFiPassword.git`\n  \n  3. Make changes to your `config.js` file.  \n  \n## How to use this module\nAs with other MM modules, add this array to the `config/config.js` file\n\n``` \nmodules:[\n  {\n    module: 'MMM-WiFiPassword',\n    position: \"top_left\",\n      config: {\n        //See 'Configuration options' for more information.\n        network: \"my_network\", \n        password: \"my_pass\",\n      }\n  },\n]\n```\n## Configuration Options \n\n| Option | Description | Default |\n| ------------- | ------------- | ------------- |\n| `qrSize`  | The width and height of QRCode in pixels. | 125 |\n| `colorDark`  | The color of the \"dark\" area of the QRCode in hex. | #fff |\n| `colorLight`  | The color of the \"light\" area of the QRCode in hex. | #000 |\n| `authType`  | Your authentication type. Options are `WPA` `WEP` `NONE` | WPA |\n| `network`  | Your network SSID. | REQUIRED |\n| `password`  | Your network Password. | REQUIRED |\n| `hiddenId`  | Whether your SSID is hidden. `true` `false` | false |\n| `header`  | Custom header text.  | Local WiFi Details | \n| `layoutVertical`  | Whether to display in vertical (`true`), or horizontal (`false`) mode.  | true |\n| `showNetwork`  | Show network SSID. `true` `false`| true |\n| `showPassword`  | Show your network password. `true` `false` | true |\n| `showAuthType`  | Show your authentication type. `true` `false` | true |\n| `debug`  | Displays raw QR text. `true` `false` | false |\n\n## Notifications\n\nYou can interact with this module with the following `notifications`:\n\n| Notification | Payload | Description | Requirements |\n| ------------ | ------- | ----------- | ------------ |\n| `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](https://github.com/fewieden/MMM-Modal) |\n\n\n## Supported modules\n\nThis module has support for [\"MMM-Modal\"](https://github.com/fewieden/MMM-Modal). See [Notifications](#notifications) above.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTeraTech%2FMMM-WiFiPassword","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FTeraTech%2FMMM-WiFiPassword","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FTeraTech%2FMMM-WiFiPassword/lists"}