Skip to content

feat(timer): added timer#82

Merged
finger563 merged 2 commits intomainfrom
feature/timer
Jun 30, 2023
Merged

feat(timer): added timer#82
finger563 merged 2 commits intomainfrom
feature/timer

Conversation

@finger563
Copy link
Contributor

Description

  • Added timer component which is a simple wrapper around a task focused on providing some periodicity to the execution of the callback, with the caveat that the timer callback should not block / sleep
  • Added example for timer component
  • Updated and rebuilt docs
  • Updated ci

Motivation and Context

Running a callback function periodically involves boilerplate code that this new timer component helps to alleviate and adds some additional features such as the ability to make the timer a one-shot timer (by setting the period to 0) and / or to have an optional delay before the first execution of the callback.

How has this been tested?

Building and running the new timer example.

Screenshots (if appropriate, e.g. schematic, board, console logs, lab pictures):

CleanShot 2023-06-30 at 09 53 37

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation Update
  • Hardware (schematic, board, system design) change
  • Software change

Checklist:

  • My change requires a change to the documentation.
  • I have added / updated the documentation related to this change via either README or WIKI

Software

  • I have added tests to cover my changes.
  • I have updated the .github/workflows/build.yml file to add my new test to the automated cloud build github action.
  • All new and existing tests passed.
  • My code follows the code style of this project.

* Added timer component which is a simple wrapper around a task focused on providing some periodicity to the execution of the callback, with the caveat that the timer callback should not block / sleep
* Added example for timer component
* Updated and rebuilt docs
* Updated ci
@finger563 finger563 added enhancement New feature or request timer labels Jun 30, 2023
@finger563 finger563 self-assigned this Jun 30, 2023
@finger563 finger563 merged commit 135b45f into main Jun 30, 2023
@finger563 finger563 deleted the feature/timer branch June 30, 2023 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request timer

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant