⭐️ Star us on GitHub — it helps!
wifi-qr-code-generator is an npm module to generate a QR Code to connect to your WiFi. Supports WiFi QR Codes in PNG, SVG, Terminal and UTF output formats. Works in both node server and browser.
## Install
Using NPM:
```sh
$ npm install wifi-qr-code-generator
```
Using Yarn:
```sh
$ yarn add wifi-qr-code-generator
```
## Usage
### Basic API — Generating a PNG QR Code
```javascript
const qrcode = require('wifi-qr-code-generator')
const pr = qrcode.generateWifiQRCode({
ssid: 'Hello world',
password: 'testpass',
encryption: 'WPA',
hiddenSSID: false,
outputFormat: { type: 'image/png' }
})
pr.then((data) => console.log(data))
```
This prints the following output:
```
data:image/png;base64,iVBORw0KGgoAAA...
```
You can pass this data URL to an html `img` tag to generate the following QR code image:
### API Explanation
Main API call is `generateWifiQRCode` which is shown in the example above. This method takes an object of the following format:
```typescript
export interface Config {
ssid: string
password: string
encryption: 'WPA' | 'WEP' | 'None'
hiddenSSID: boolean
outputFormat: OutputFormat
}
export interface OutputFormat {
type: 'image/png' | 'utf8' | 'svg' | 'terminal'
}
```
1. `ssid`: string representation of your wireless SSID (Wifi name). Max length possible for WiFi SSID is 32 characters for most routers. However this library doesn't impose any limitation on the length of SSID that can be passed in.
1. `password`: string representation of your WiFi password
1. `encryption`: Possible values here are `WPA`, `WEP` and `None`. If you are using WPA2, enter `WPA`. Please note that WEP protocol has multiple security vulnerabilities and you shouldn't be configuring your WiFi router to use WEP at all.
1. `hiddenSSID`: should be `true` if your router is configured to NOT broadcast your SSID. Else `false`
1. `outputFormat`: An object that has a single `type` field
Possible values of `type` are:
1. `"image/png"`: `generateWifiQRCode` will generates a data URL representing a PNG image
1. `"svg"`: `generateWifiQRCode` will generates an SVG image in string format
1. `utf8`: `generateWifiQRCode` will generates a UTF8 representation of the QR code
1. `terminal`: `generateWifiQRCode` will generates a string that can be pretty printed as QR code in the terminal
### Generating a SVG QR Code
```javascript
const qrcode = require('wifi-qr-code-generator')
const pr = qrcode.generateWifiQRCode({
ssid: 'Hello world',
password: 'testpass',
encryption: 'WPA',
hiddenSSID: false,
outputFormat: { type: 'svg' }
})
pr.then((data) => console.log(data))
```
This prints the following output:
```
### API Explanation
Main API call is `generateWifiQRCode` which is shown in the example above. This method takes an object of the following format:
```typescript
export interface Config {
ssid: string
password: string
encryption: 'WPA' | 'WEP' | 'None'
hiddenSSID: boolean
outputFormat: OutputFormat
}
export interface OutputFormat {
type: 'image/png' | 'utf8' | 'svg' | 'terminal'
}
```
1. `ssid`: string representation of your wireless SSID (Wifi name). Max length possible for WiFi SSID is 32 characters for most routers. However this library doesn't impose any limitation on the length of SSID that can be passed in.
1. `password`: string representation of your WiFi password
1. `encryption`: Possible values here are `WPA`, `WEP` and `None`. If you are using WPA2, enter `WPA`. Please note that WEP protocol has multiple security vulnerabilities and you shouldn't be configuring your WiFi router to use WEP at all.
1. `hiddenSSID`: should be `true` if your router is configured to NOT broadcast your SSID. Else `false`
1. `outputFormat`: An object that has a single `type` field
Possible values of `type` are:
1. `"image/png"`: `generateWifiQRCode` will generates a data URL representing a PNG image
1. `"svg"`: `generateWifiQRCode` will generates an SVG image in string format
1. `utf8`: `generateWifiQRCode` will generates a UTF8 representation of the QR code
1. `terminal`: `generateWifiQRCode` will generates a string that can be pretty printed as QR code in the terminal
### Generating a SVG QR Code
```javascript
const qrcode = require('wifi-qr-code-generator')
const pr = qrcode.generateWifiQRCode({
ssid: 'Hello world',
password: 'testpass',
encryption: 'WPA',
hiddenSSID: false,
outputFormat: { type: 'svg' }
})
pr.then((data) => console.log(data))
```
This prints the following output:
```