Skip to content

Commit 9879e38

Browse files
docs: add Sense HAT changelog entry and symlink instructions
- Document Sense HAT module in CHANGELOG.md - Extend README with Raspberry Pi deployment and module symlink example
1 parent 37f7038 commit 9879e38

File tree

2 files changed

+24
-3
lines changed

2 files changed

+24
-3
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ Thanks to: @Crazylegstoo, @dathbe, @m-idler, @plebcity, @khassel, @KristjanESPER
6969
- Add configuration option for `User-Agent`, used by calendar & news module (#3255)
7070
- [linter] Add prettier plugin for nunjuck templates (#3887)
7171
- [core] Add clear log for occupied port at startup (#3890)
72+
- [sensehat] Sense HAT integration module (`sensehat`) to display temperature, humidity, pressure, optional orientation, and to control the LED matrix on Raspberry Pi.
7273

7374
### Changed
7475

modules/default/sensehat/README.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,29 @@ sudo apt install -y sense-hat python3-sense-hat
2020

2121
Installation
2222

23-
1. Copy the modules/default/sensehat folder into your MagicMirror installation on the Raspberry Pi (or keep it in your repo and deploy it).
24-
2. Ensure the Python helper is executable (optional):
25-
- chmod +x modules/default/sensehat/python/reader.py
23+
The module lives in this repository under `modules/default/sensehat`.
24+
25+
On a real Raspberry Pi installation of MagicMirror, you can deploy it in one of two ways:
26+
27+
1. Keep it under `modules/default/sensehat` and create a symlink so MagicMirror can also find it as `modules/sensehat`:
28+
- cd ~/MagicMirror/modules
29+
- ln -s default/sensehat sensehat
30+
31+
2. Alternatively, place the module directly under `modules/sensehat` (preferred by some maintainers for non-core modules).
32+
33+
Additionally, ensure the Python helper is executable (optional):
34+
35+
- chmod +x modules/default/sensehat/python/reader.py
36+
37+
### Raspberry Pi deployment example
38+
39+
Assuming your MagicMirror installation is in `~/MagicMirror`:
40+
41+
```
42+
cd ~/MagicMirror/modules
43+
# if the module is under modules/default/sensehat, create a symlink
44+
ln -s default/sensehat sensehat
45+
```
2646

2747
Configuration
2848
Add the module to your config/config.js:

0 commit comments

Comments
 (0)