8000 Adding Inkplate 6 docs by nitko12 · Pull Request #778 · esphome/esphome-docs · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Adding Inkplate 6 docs #778

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
merged 10 commits into from
Jan 16, 2021
Merged

Adding Inkplate 6 docs #778

merged 10 commits into from
Jan 16, 2021

Conversation

nitko12
Copy link
Contributor
@nitko12 nitko12 commented Sep 21, 2020

Description:

Changed branch from #768 PR.

Pull request in esphome with YAML changes (if applicable): esphome/esphome#1283

Checklist:

  • Branch: next is for changes and new documentation that will go public with the next ESPHome release. Fixes, changes and adjustments for the current release should be created against current.
  • Link added in /index.rst when creating new documents for new components or cookbook.

@jesserockz
Copy link
Member

Thanks @nitko12
Take a look at the st7789v display documentation for the structure of the page of a single board display.
In short:

  • Add a minimum configuration block for just the display component and its dependencies (mcp23017/i2c).
  • Warning block notifying users the pins cannot be changed.
  • Also add the Configuration variables section to explain each configuration option.
  • You can leave the complete example below the main documentation.

Jesse

@nitko12
Copy link
Contributor Author
nitko12 commented Sep 22, 2020

Thank you @jesserockz !

What should I write in configuration options?
Also, have I done other things on your list correctly?
:)

@jesserockz
Copy link
Member

@nitko12 yeah looks good.

Using the same layout as the other display docs:

Add a simple explanation for the all of the config options available for the display component. greyscale partial_updating and pins etc.

You can copy the description of the common options from the other displays. id / name update_interval / lambda / pages as we don't have a common block on the docs yet.

@nitko12
Copy link
Contributor Author
nitko12 commented Sep 22, 2020

@jesserockz is it okay now?

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
@jesserockz
Copy link
Member

Looking better. Maybe add a note somewhere about partial updating being ignored when greyscale is used?
Then I think it should be good.

@nitko12
Copy link
Contributor Author
nitko12 commented Sep 22, 2020

Added that, so were set to merge now?

Copy link
Member
@jesserockz jesserockz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah I think so. It will be merged at the same time as esphome/esphome#1283


All-in-one e-paper display ``Inkplate 6``
Inkplate 6 is a powerful, Wi-Fi enabled ESP32 based six-inch e-paper display – recycled from a Kindle e-reader. Its main feature is simplicity.
Learn more at `our website <https://inkplate.io/>`__
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please write inkplate's website instead. I don't want to give the impression that ESPHome is somehow directly related to inkplate (users viewing the docs won't look who made the docs PR)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done that :D

@ngdio
Copy link
ngdio commented Oct 24, 2020

Not sure how the status on this is, but reading the battery voltage from the example doesn't work on my Inkplate. Adding something for the battery sensor would be nice too.

Copy link
Member
@jesserockz jesserockz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some changes to fix battery voltage example

@jesserockz jesserockz added this to the 1.16.0b4 milestone Jan 16, 2021
@jesserockz jesserockz merged commit b6eeb6e into esphome:next Jan 16, 2021
jesserockz added a commit that referenced this pull request Jan 17, 2021
* Added Inkplate.

* Fixing Inkplate docs.

* Added Configuration variables for Inkplate.

* Update components/display/Inkplate.rst

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>

* Added another warning.

* Fixed indents.

* Done requested change

* Add pin configurations to docs

* Apply suggestions from code review

Co-authored-by: Jesse Hills <3060199+jesserockz@users.noreply.github.com>
@jesserockz jesserockz mentioned this pull request Jan 17, 2021
This was referenced Feb 3, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Oct 25, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0