Tiny4kOLED icon indicating copy to clipboard operation
Tiny4kOLED copied to clipboard

Is there more documentation somewhere?

Open IdontKnowWhatToNameThisAccount opened this issue 1 year ago • 3 comments

There are a lot of functions used in the examples that arent properly explained or documented anywhere, or at least I cant seem to find them. For example I dont really understand how oled.fill is supposed to work. Is there some documentation that simply explains the functionality of each function?

Most functions are simply exposing commands of the SSD1306. These can be found by searching google for: ssd1306 datasheet "rev 1.5"

datacute avatar Jul 25 '22 05:07 datacute

I would suggest linking to a copy of the latest datasheet referenced while working on development of this library. Unless the manufacturer keeps moving it around; Microchip now does this constantly for the AVRs, which is why I don't link directly to AVR datasheets anymore; I link to the Microchip product pages (mTC and DxC only currently) - where the latest, usually working - links are to be found.)

SpenceKonde avatar Feb 27 '23 10:02 SpenceKonde

Okay, yeah, this also needs an API reference. Right now now I don't know how anyone does anything with this library? Do perform a deep dive on the source and write their own documentation and not share it? Do they just blindly copy-paste example code cargo-cult style then tweak it? (which of course is well known as a development anti-pattern)?

Here's what the path ahead of me looks like.

(what I want to do) -X BRIDGE OUT X- (API calls to make)------(data that gets set to screen)-----(what I want done)

The first step in the transformation of vision to working code is blackflagged at the gate because there is literally NO documentation whatsoever.

And I've got a lot of these screens... I'd like to use them, and your library is said to be highly flash important (which matters, some of these are going on tinies), but I don't know how to learn the API short of a deep dive to write my own docs. LotsOfOLEDs

SpenceKonde avatar Feb 27 '23 22:02 SpenceKonde