Skip to content

moosedookie/phone-notification-mirror

 
 

Repository files navigation

Phone Notification - Mirror

Displays and alerts mirror users on new phone notifications.

Phone Visualization

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:

modules: [
	{
		    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
            },
	}
]

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' } ]
		</td>
	</tr>

	<tr>
		<td><code>fade</code></td>
		<td>Fade older notifications to black. (Gradient)<br>
			<br><b>Possible values:</b> <code>true</code> or <code>false</code>
			<br><b>Default value:</b> <code>true</code>
		</td>
	</tr>
	<tr>
		<td><code>maxCharacters</code></td>
		<td>Number of characters to display per notification body<br>
			<br><b>Default value:</b> <code>50</code>
		</td>
	</tr>

</tbody>

About

Displays and alerts mirror users on new phone notifications

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 93.3%
  • CSS 6.7%