Repository navigation
Conversation
Explain what alarms are for and document the full alarm API in one place: declaring alarms, csp.schedule_alarm with a timedelta or a datetime, the handle it returns, csp.reschedule_alarm and csp.cancel_alarm (neither was documented before), how ticks scheduled for the same time are processed, and the errors raised. Includes an example node that detects a stale input with a timeout alarm. Also fill in the Alarm entry in the glossary. Fixes Point72#130 Signed-off-by: Laksh Agarwal <lakshagarwal65@gmail.com>
Lotion-3
requested review from
AdamGlustein,
alexddobkin,
robambalu and
svatasoiu
as code owners
November 14, 2026 02:30
Member
|
Thanks for the PR! I've consolidated some docs updates in #795 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #130.
Alarms are mentioned on several pages, but there was no single place that explains them, and
csp.reschedule_alarmandcsp.cancel_alarmweren't documented. This adds an "Alarms" section to the CSP Node page that covers:csp.schedule_alarmwith atimedeltaor adatetime, and the handle it returns;csp.reschedule_alarmandcsp.cancel_alarm, including what happens when the tick has already happened;It also fills in the "Alarm" glossary entry, which was a TODO.
I checked each statement against csp 0.19.1, and ran the example.
make lint-docspasses.