Phone Notification - Mirror

Displays and alerts mirror users on new phone notifications.

Getting Started

Firstly, a Pushbullet app is required on the phone. After downloading and installing the application on your phone, get a Pushbullet Access Token from your Account Settings.

Installing the module

To install the module, just clone this repository to your modules folder: git clone https://github.com/ronny3050/phone-notification-mirror.git phone_notification. Then run cd phone_notification and npm install which will install the dependencies.

Using the module

To use this module, add it to the modules array in the config/config.js file:

	{
		    module: 'phone_notification',
            position: 'bottom_right',
            header: 'Phone Notifications',
            config:{
                accessToken: 'YOUR_ACCESS_TOKEN',
                numberOfNotifications: 5,
                displayNotificationIcon: true,
                displayMessage: true,
                displayCount: false,
                alert: false,
                fade: true,
				maxCharacters: 50
				useEncryption: true,
				key: {
					password: 'YOUR_PASSWORD',
					ident: 'YOUR_USER_IDENT'
				}
            }
	},

Configuration options

The following properties can be configured:

Option	Description
`accessToken`	Your Pushbullet Access Token
`numberOfNotifications`	Number of notifications to display at a time Default value: `5` If set to 0, no notification messages will be displayed.
`displayNoticiationIcon`	Display app icon that generated the notification Possible values: `true` or `false` Default value: `true`
`displayMessage`	Display body of the notification Possible values: `true` or `false` Default value: `true`
`displayCount`	Display notification count Possible values: `true` or `false` Default value: `true`
`alert`	Show alerts on new notification Possible values: `true` or `false` Default value: `true` Please note that this requires the alert module to be present in the config file. For instance, `modules: [ { widget: 'alert' } ]`
`fade`	Fade older notifications to black. (Gradient) Possible values: `true` or `false` Default value: `true`
`maxCharacters`	Number of characters to display per notification body Default value: `50`
`useEncryption`	Enable encrypted communication Default value: `false`
`key`	An object with the password and the ident. Used for decryption. Default value: `See key configuration below`

key options

The following properties can be configured:

Option	Description
`password`	Password supplied by the user for encryption, must be the same on all Pushbullet devices owned by the user Default value: `none`
`ident`	The user iden for the current user Request iden with: `curl --header 'Access-Token: <your_access_token_here>' https://api.pushbullet.com/v2/users/me` Default value: `none`