Incorrect information about attachSystemInterrupt for Boron

Open
#1,126 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale

Research direction

Start with the Boron documentation page at the linked attachSystemInterrupt reference and reproduce the example's compilation error. Compare the example with the Device OS implementation mentioned in the report to determine whether the API applies to Boron. Done means the Boron documentation accurately describes supported usage and its example no longer gives misleading guidance.

Written by the indexing model from the issue text.

Description

https://docs.particle.io/reference/device-os/firmware/boron/#attachsysteminterrupt-

If I try to compile that example code for Boron, I get an error:

error: 'SysInterrupt_TIM5' was not declared in this scope
   22 |     attachSystemInterrupt(SysInterrupt_TIM5, timer_event_handler);

From a brief look at the deviceOS code, I think this function is for other platforms, and is not implemented for the Boron?

Dominant language
JavaScript
Stars
148
Forks
266
Avg merge
14h 41m
Merged PRs (30d)
16

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from particle-iot/docs

All issues in particle-iot/docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.