bryan
/
BangleApps
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme

master
Gordon Williams 2022-04-06 19:45:27 +01:00
parent dfd5461fd9
commit 3c28c0c9c9
3 changed files with 32 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
apps/compass/README.md Normal file
View File

@ -0,0 +1,29 @@
# Compass
This app uses Bangle.js's built-in magnetometer as a compass.
## Usage
Hold your Bangle.js **face up** (so the display is parallel to the ground),
and the red arrow will point north, with the heading in degrees printed at
the top of the screen.
This compass app does not include tilt compensation - so much like a real
compass you should always keep it face up when taking a reading.
The first time you run the compass after your Bangle has booted (or if
you move to an area with a substantially different magnetic field) you will
need to recalibrate your compass (even if a heading is shown).
## Calibration
Press the button next to the `RESET` label on the screen. The North/South marker
will disappear and a message will appear asking you to rotate the watch 360 degrees.
* Hold the watch face up, so the display is parallel to the ground
* Rotate it around slowly, all 360 degrees (with the display still parallel to the ground)
* The `Uncalibrated` message will disappear before you have finished rotating the full 360 degrees - but you should still complete the full rotation in order for the compass to work properly.
Once you've rotated the full 360 degrees your compass should now work fine,
and calibration is stored between runs of the app. However if you go near
to a strong magnet you may still need to recalibrate.

4
apps/compass/compass.js
View File

@ -38,7 +38,7 @@ Bangle.on('mag', function(m) {
if (!wasUncalibrated) {
g.clearRect(0,24,W,48);
g.setFontAlign(0,-1).setFont("6x8");
g.drawString("Uncalibrated\nturn 360° around",M,24+4);
g.drawString(/*LANG*/"Uncalibrated\nturn 360° around",M,24+4);
wasUncalibrated = true;
}
} else {
@ -65,7 +65,7 @@ Bangle.on('mag', function(m) {
});
g.clear(1);
g.setFont("6x8").setFontAlign(0,0,3).drawString("RESET", g.getWidth()-5, g.getHeight()/2);
g.setFont("6x8").setFontAlign(0,0,3).drawString(/*LANG*/"RESET", g.getWidth()-5, g.getHeight()/2);
setWatch(function() {
Bangle.resetCompass();
}, (process.env.HWVERSION==2) ? BTN1 : BTN2, {repeat:true});

1
apps/compass/metadata.json
View File

@ -7,6 +7,7 @@
"screenshots": [{"url":"screenshot_compass.png"}],
"tags": "tool,outdoors",
"supports": ["BANGLEJS","BANGLEJS2"],
"readme": "README.md",
"storage": [
{"name":"compass.app.js","url":"compass.js"},
{"name":"compass.img","url":"compass-icon.js","evaluate":true}