Discussion: CapturePin trait

Open
#176 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
30/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
rust
Domain
embedded-iot

Research direction

Start by reviewing the existing Capture and PwmPin traits, then read the prototype in PR 173. Compare the proposed single-channel capture() API with the stated omission of enable and disable. Done means reaching agreement on the CapturePin design and its relationship to Capture and any possible sub-trait.

Written by the indexing model from the issue text.

Description

discussion

I'd like to propose a new CapturePin trait for representing a single input capture channel. It is to the Capture trait what PwmPin is to Pwm. Since single-channel singleton abstractions are preferable to multi-channel abstractions, a trait like CapturePin should become the recommended way to handle input capture hardware. The trait will only have the method .capture(), which has the same API as the same method in Capture trait except it doesn't pass in a channel. Since not every chip supports enabling/disabling single capture channels, the enable and disable methods are omitted (perhaps they can be a separate sub-trait). For a prototype of what the trait will look like, refer to this PR.

Dominant language
Rust
Stars
2.7k
Forks
282
No merged PRs in 30d

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 rust-embedded/embedded-hal

All issues in rust-embedded/embedded-hal

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.