https://github.com/aduyng/MMM-TeslaStatus

A MagicMirror widget showing the status of my Tesla
https://github.com/aduyng/MMM-TeslaStatus

firebase firebase-database magicmirror2 nodejs

Last synced: 22 days ago
JSON representation

A MagicMirror widget showing the status of my Tesla

• Host: GitHub
• URL: https://github.com/aduyng/MMM-TeslaStatus
• Owner: aduyng
• License: mit
• Created: 2019-06-20T04:27:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-06-20T05:12:38.000Z (over 5 years ago)
• Last Synced: 2024-08-04T10:03:29.931Z (4 months ago)
• Topics: firebase, firebase-database, magicmirror2, nodejs
• Language: JavaScript
• Size: 78.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-mmm - **MMM-TeslaStatus**

README

        
# MMM-TeslaStatus

A [MagicMirror](https://github.com/MichMich/MagicMirror)'s Module to show my Tesla status using [Firebase Realtime Database](https://firebase.google.com/docs/database)

The project consumes data posted by [https://github.com/aduyng/tesla-client](https://github.com/aduyng/tesla-client) which pushes tesla status to a firebase.

[![CircleCI](https://circleci.com/gh/aduyng/MMM-TeslaStatus/tree/master.svg?style=svg)](https://circleci.com/gh/aduyng/MMM-TeslaStatus/tree/master)

## Screenshots

![status](./docs/images/tesla.png)

## Installation

### 1. Setup the MagicMirror module

```bash

cd ~/MagicMirror/modules

git clone https://github.com/aduyng/MMM-TeslaStatus.git

cd MMM-TeslaStatus

npm install --production

```

### 2. Setup Firebase Realtime Database

You will need a realtime database for Smartthings to push the device status to. Follow this tutorial, https://firebase.google.com/docs/web/setup, to setup a Firebase project and a realtime database.

Take note of the project configuration especially the realtime database URL.

## Configuration

```javascript

  {

			module: "MMM-TeslaStatus",

			position: "top_right",

			config: {

				firebaseDatabaseRootRef: '/vehicles/', // the path of the realtime database to listen to

				firebaseConfig : {

					apiKey: "",

					databaseURL: "",

					projectId: "",

					appId: ""

				}

			}

  }

```