FOSS
/
BangleApps
mirror of https://github.com/espruino/BangleApps
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

improve sched readme

pull/2120/head
Gordon Williams 2022-09-09 09:37:10 +01:00
parent 20c4f06718
commit b2bb45d878
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
apps/sched/README.md
View File

@ -70,11 +70,21 @@ let alarm = require("sched").newDefaultAlarm();
// Get a new timer with default values
let timer = require("sched").newDefaultTimer();
// Add/update an existing alarm
require("sched").setAlarm("mytimer", {
// Add/update an existing alarm (using fields from the object shown above)
require("sched").setAlarm("mytimer", { // as a timer
msg : "Wake up",
timer : 10 * 60 * 1000 // 10 minutes
});
require("sched").setAlarm("myalarm", { // as an alarm
msg : "Wake up",
t : 9 * 3600000 // 9 o'clock (in ms)
});
require("sched").setAlarm("mydayalarm", { // as an alarm on a date
msg : "Wake up",
date : "2022-04-04",
t : 9 * 3600000 // 9 o'clock (in ms)
});
// Ensure the widget and alarm timer updates to schedule the new alarm properly
require("sched").reload();