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

Document `pin.pull` functionality #93

Closed
HipsterBrown opened this Issue Aug 26, 2016 · 1 comment

Comments

Projects
None yet
3 participants
@HipsterBrown
Contributor

HipsterBrown commented Aug 26, 2016

@dudleyjosh noticed that the pin.pull(mode) functionality is currently undocumented (Reference -> https://tessel.gitbooks.io/t2-docs/content/API/Hardware_API.html).

Documentation and examples for using this method could go under the "Pin mapping" section, where it is explained that "by default, all of the pins are pulled high if not specifically set".

I think it would be nice to match the structure of the Pin Interrupts docs:

  • add a working Fritzing example to match the code sample (maybe with a button)
  • add a "Usage" section that describes what values pull takes as arguments (see the Interrupts usage section as an example)

Check out the t2-firmware source for more info about how each method works:

Feel free to mention me in this issue, or a PR, or post in Tessel Slack #community channel with question or if review is needed.

@mittalshravika

This comment has been minimized.

Show comment
Hide comment
@mittalshravika

mittalshravika Jul 26, 2017

Contributor

@HipsterBrown, Brihi and I (members of 276linesofCode) have started working on this issue.

We were trying to explain the pin.pull(mode) command using an example with a push button. For the same, we were thinking of linking the code with a fritzing diagram.

Could you let us know where to put the fritzing diagram because we could not find any other in the t2-docs to refer to as an example.

Contributor

mittalshravika commented Jul 26, 2017

@HipsterBrown, Brihi and I (members of 276linesofCode) have started working on this issue.

We were trying to explain the pin.pull(mode) command using an example with a push button. For the same, we were thinking of linking the code with a fritzing diagram.

Could you let us know where to put the fritzing diagram because we could not find any other in the t2-docs to refer to as an example.

@brihijoshi brihijoshi referenced this issue Aug 1, 2017

Merged

fixes #93 #167

@Frijol Frijol closed this in #167 Sep 17, 2017

Frijol added a commit that referenced this issue Sep 17, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment