MMM-LocalTemperature

This is a module for the MagicMirror² smart mirror project.

This module reads and displays temperature and humidity information from a sensor connected to a Raspberry Pi GPIO pin.

Example

Notable Features

1. Get data from a DHT11, DHT22, or AM2302 sensor
2. Display the temperature and/or humidity from this module and/or,
3. Send the temperature to the built in 'weather' module via module notifications

Dependencies

1. A local 'c' program, used to read the data from the sensor (included)
2. The WiringPi library (Free to install and use)

Installation

To install the module, use your terminal to:

1. Navigate to your MagicMirror's modules folder. If you are using the default installation directory, use the command:
   cd ~/MagicMirror/modules
2. Copy the module to your computer by executing the following command:
   git clone https://github.com/glitch452/MMM-LocalTemperature.git
3. Install the WiringPi library by executing the following command:
   sudo apt-get -y update && sudo apt-get -y upgrade && sudo apt-get -y install build-essential wiringpi Note: If running on Raspberry Pi 4, use the following process to update wiringpi
   http://wiringpi.com/wiringpi-updated-to-2-52-for-the-raspberry-pi-4b
4. Make sure the DHT program that reads the sensor data is executable by executing the following command:
   cd MMM-LocalTemperature && chmod +x DHT

Using the module

MagicMirror² Configuration

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

var config = {
    modules: [
        ...
        {
            module: "MMM-LocalTemperature",
            position: "top_left", // Only add a position if you want this module to display the data
            header: "Room Temperature",
            config: {
                sensorPin: 22, // For GPIO 22
                ...
                // See below for more Configuration Options
            }
        },
        ...
    ]
}

Configuration Options

Connecting the Sensor to the Raspberry Pi

Here are some diagrams that you may find useful when connecting your sensor. See the guide from adafruit.com for more wiring and programming information.

DHT11 sensor

DHT22 / AM2302 sensor

AM2302 sensor with wires

Customizing the DHT Program

The DHT program is a c coded program used to read the sensor data. A c program is required to read the sensor data because the data is transmitted by extremely short pulses of signal and the c code executes much faster than python.

The included DHT program is something I pieced together based on code from dht22 by nebulx29 and the Python DHT Sensor Library by Adafruit.

If you would like to customize the DHT program, you can edit the file DHT.c with your favorite editor, then re-compile it using the following command: cc -Wall DHT.c -o DHT -lwiringPi

Updates

To update the module to the latest version, use your terminal to:

1. Navigate to your MMM-LocalTemperature folder. If you are using the default installation directory, use the command:
   cd ~/MagicMirror/modules/MMM-LocalTemperature
2. Update the module by executing the following command:
   git pull

If you have changed the module on your own, the update will fail.
To force an update (WARNING! your changes will be lost), reset the module and then update with the following commands:

git reset --hard
git pull

Manually Choose a Version

To use an older version of this module, use your terminal to:

1. Navigate to your MMM-LocalTemperature folder. If you are using the default installation directory, use the command:
   cd ~/MagicMirror/modules/MMM-LocalTemperature
2. Fetch all the available tags
   git fetch
3. Show all the available tags
   git tag
4. Checkout one of the available tags
   git checkout {tag_name}
   Example: git checkout v1.0.0

To switch back to the latest version, use your terminal to:

1. Navigate to your MMM-LocalTemperature folder. If you are using the default installation directory, use the command:
   cd ~/MagicMirror/modules/MMM-LocalTemperature
2. Checkout the master branch
   git checkout master

License

The MIT License (MIT)

Copyright © 2018 David Dearden

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.