Comments (4)
Cf. #49
from ssd1306.
Relevant discussion in #7
from ssd1306.
Some specific things I've noticed in the rendered docs:
- There should be a platform-agnostic example on the docs landing page with a graphics example, probably exercising all bits of the embedded_graphics API (triangle, square, circle, text, image). This will get updated with a following char mode example when #27 is ready. A link to a runnable example demonstrating the same for each display mode would be good too.
- To extend the previous point, there should be an explanation of the concept of display modes; this driver can't be used without choosing one!
- There should be better links between types/other language constructs in the docs
- Readme:
- The image needs to go on a diet. It's huge at the moment.
graphics
is on by default and no longer optional so should be de-listed- A complete copypasta for stm32f103 would be good
- Link to examples directory
- The re-exports list needs an audit. This is related to #5 so can probably be fixed over there
- Should there be a description of how all the modules fit together?
builder
needs a couple of examples. I suggest:- A default/basic one that just sets up a display in graphics mode with SPI
- One that exercises as many of the builder options as possible that changes the display size, rotation and I2C address in I2C mode.
Rotate180
doesn't actually flip the display, it just (uh...) rotates it.interface
should mention the ridiculous and not so ridiculous types required by RTFM apps.- Each mode should have an explanation of what it does. Also worth mentioning that
RawMode
shouldn't be directly used and is only a helper for the builder. Method was removed in #49.borrow_iface_mut
could use a short usage example.- Make sure each module has a more-than-one-line description of what it does, preferably with a code example.
from ssd1306.
borrow_iface_mut could use a short usage example.
Actually that should go away and the "DisplayProperties" (or whatever the name will end up to be in the end) should provide proper methods to change configuration and send data.
from ssd1306.
Related Issues (20)
- Basic mode clear doesn't work in page addressing mode
- 0.6.0 Upgrade problem HOT 1
- memchr does not declare `#![no_std]` HOT 4
- Issues on Adafruit OLED Bonnet HOT 1
- ssd1306 with rtic 1.0.0 HOT 7
- memory.x or probe-run "fix" HOT 6
- [N00b help request] Init fails with Raspberry Pi Pico and Adafruit OLED HOT 3
- Noob Issue: Cant manage to get this building for the stm32f1xx_hal HOT 6
- Newbie: No signs of life from SSD1306 atmega32u4 SPI 128x64 HOT 2
- How to use display with multiple I2C peripherals ([shared-bus] crate?) HOT 3
- Static noise when using crate with embedded_graphics HOT 4
- Using `DrawTarget::clear` is difficult in buffered graphics mode HOT 5
- `DrawTarget` is not implemented for `Ssd1306<I2CInterface<avr_hal_generic::i2c::I2c<.....` HOT 4
- Yet another `DrawTarget` is not implemented for `Ssd1306<SPIInterface<Spi... HOT 6
- Unable to draw circles & lines using embedded graphics crate
- Issues with 128x32 Display on Elegoo Arduino UnoR3
- read or toggle pixel in bufferedMode? HOT 4
- Using terminal mode with 90/270 degree rotation leads to incorrect output and panic HOT 1
- Configurable I2C address HOT 1
- trait `DrawTarget` is not implemented for ... / esp_idf_hal::i2c::*
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ssd1306.