-
Notifications
You must be signed in to change notification settings - Fork 235
Move reading functions from OutputPin trait to StatefulOutputPin #72
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+83
−6
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
97fac76
Remove reading functions from OutputPin trait
astro 3f61ef2
Add StatefulOutputPin to read and toggle the state of OutputPin
astro ac965a3
separate OutputPin.toggle() into ToggleableOutputPin, provide default…
astro 6549d73
move ToggleableOutputPin default impl to opt-in trait + doc
astro File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,19 +2,96 @@ | |
/// Single digital output pin | ||
pub trait OutputPin { | ||
/// Is the output pin high? | ||
fn is_high(&self) -> bool; | ||
|
||
/// Is the output pin low? | ||
fn is_low(&self) -> bool; | ||
|
||
/// Sets the pin low | ||
fn set_low(&mut self); | ||
|
||
/// Sets the pin high | ||
fn set_high(&mut self); | ||
} | ||
|
||
/// Output pin that can read its output state | ||
#[cfg(feature = "unproven")] | ||
pub trait StatefulOutputPin { | ||
/// Is the pin set to high? | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. A pin could also be logically floating so either it needs to be made clear that a tri-stated pin may not implement this trait or that the implicit assumption |
||
fn is_set_high(&self) -> bool; | ||
|
||
/// Is the pin set to low? | ||
fn is_set_low(&self) -> bool; | ||
} | ||
|
||
/// Output pin that can be toggled | ||
/// | ||
/// See [toggleable](toggleable) to use a software implementation if | ||
/// both [OutputPin](trait.OutputPin.html) and | ||
/// [StatefulOutputPin](trait.StatefulOutputPin.html) are | ||
/// implemented. Otherwise, implement this using hardware mechanisms. | ||
#[cfg(feature = "unproven")] | ||
pub trait ToggleableOutputPin { | ||
/// Toggle pin output. | ||
fn toggle(&mut self); | ||
} | ||
|
||
/// If you can read **and** write the output state, a pin is | ||
/// toggleable by software. | ||
/// | ||
/// ``` | ||
/// use embedded_hal::digital::{OutputPin, StatefulOutputPin, ToggleableOutputPin}; | ||
/// use embedded_hal::digital::toggleable; | ||
/// | ||
/// /// A virtual output pin that exists purely in software | ||
/// struct MyPin { | ||
/// state: bool | ||
/// } | ||
/// | ||
/// impl OutputPin for MyPin { | ||
/// fn set_low(&mut self) { | ||
/// self.state = false; | ||
/// } | ||
/// fn set_high(&mut self) { | ||
/// self.state = true; | ||
/// } | ||
/// } | ||
/// | ||
/// impl StatefulOutputPin for MyPin { | ||
/// fn is_set_low(&self) -> bool { | ||
/// !self.state | ||
/// } | ||
/// fn is_set_high(&self) -> bool { | ||
/// self.state | ||
/// } | ||
/// } | ||
/// | ||
/// /// Opt-in to the software implementation. | ||
/// impl toggleable::Default for MyPin {} | ||
/// | ||
/// let mut pin = MyPin { state: false }; | ||
/// pin.toggle(); | ||
/// assert!(pin.is_set_high()); | ||
/// pin.toggle(); | ||
/// assert!(pin.is_set_low()); | ||
/// ``` | ||
#[cfg(feature = "unproven")] | ||
pub mod toggleable { | ||
use super::{OutputPin, StatefulOutputPin, ToggleableOutputPin}; | ||
|
||
/// Software-driven `toggle()` implementation. | ||
pub trait Default: OutputPin + StatefulOutputPin {} | ||
|
||
impl<P> ToggleableOutputPin for P | ||
where | ||
P: Default, | ||
{ | ||
/// Toggle pin output | ||
fn toggle(&mut self) { | ||
if self.is_set_low() { | ||
self.set_high(); | ||
} else { | ||
self.set_low(); | ||
} | ||
} | ||
} | ||
} | ||
|
||
/// Single digital input pin | ||
#[cfg(feature = "unproven")] | ||
pub trait InputPin { | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As I've mentioned before there's a distinction between a logical state and an electrical state. It should be made clear that this is meant to represent the logical (or register) state of a pin and not the electrical state.