MirrorSave
/
nodemcu-firmware
mirror of https://github.com/nodemcu/nodemcu-firmware.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

comply with new rules

This commit is contained in:
devsaurus 2016-01-09 01:10:27 +01:00
parent 9ca35b1fff
commit b06a3cd5e7
2 changed files with 22 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
docs/en/modules/u8g.md
View File

@ -112,10 +112,10 @@ Initialize a display via I2C.
`u8g.ssd1306_128x64_i2c(address)` `u8g.ssd1306_128x64_i2c(address)`
####Parameters ####Parameters
- `address`: I2C slave address of display. - `address`: I2C slave address of display
####Returns ####Returns
u8g display object. u8g display object
####Example ####Example
@ -129,9 +129,7 @@ disp = u8g.ssd1306_128x64_i2c(sla)
``` ```
####See also ####See also
- [SPI Display Drivers](#spi-display-drivers) [SPI Display Drivers](#spi-display-drivers)
___
## SPI Display Drivers ## SPI Display Drivers
Initialize a display via Hardware SPI. Initialize a display via Hardware SPI.
@ -180,7 +178,7 @@ Initialize a display via Hardware SPI.
- `res`: GPIO pin for /RES (optional) - `res`: GPIO pin for /RES (optional)
#### Returns #### Returns
u8g display object. u8g display object
#### Example #### Example
```lua ```lua
@ -193,7 +191,7 @@ disp = u8g.ssd1306_128x64_hw_spi(cs, dc, res)
``` ```
#### See also #### See also
- [I2C Display Drivers](#i2c-display-drivers) [I2C Display Drivers](#i2c-display-drivers)
___ ___
@ -215,24 +213,20 @@ Parts of the bitmap may be outside the display boundaries. The bitmap is specifi
`disp:drawBitmap(x, y, cnt, h, bitmap)` `disp:drawBitmap(x, y, cnt, h, bitmap)`
#### Parameters #### Parameters
- `x`: X-position (left position of the bitmap). - `x`: X-position (left position of the bitmap)
- `y`: Y-position (upper position of the bitmap). - `y`: Y-position (upper position of the bitmap)
- `cnt`: Number of bytes of the bitmap in horizontal direction. The width of the bitmap is cnt*8. - `cnt`: Number of bytes of the bitmap in horizontal direction. The width of the bitmap is cnt*8.
- `h`: Height of the bitmap. - `h`: Height of the bitmap
- `bitmap`: Bitmap data supplied as string. - `bitmap`: Bitmap data supplied as string
#### Returns #### Returns
`nil` `nil`
#### Example
`lua_examples/u8glib/u8g_bitmaps.lua`
#### See also #### See also
- [u8glib drawBitmap()](https://github.com/olikraus/u8glib/wiki/userreference#drawbitmap) - [u8glib drawBitmap()](https://github.com/olikraus/u8glib/wiki/userreference#drawbitmap)
- [lua_examples/u8glib/u8g_bitmaps.lua](https://github.com/nodemcu/nodemcu-firmware/blob/master/lua_examples/u8glib/u8g_bitmaps.lua)
- [u8g.disp:drawXBM()](#u8gdispdrawxbm) - [u8g.disp:drawXBM()](#u8gdispdrawxbm)
___
## [u8g.disp:drawBox()](https://github.com/olikraus/u8glib/wiki/userreference#drawbox) ## [u8g.disp:drawBox()](https://github.com/olikraus/u8glib/wiki/userreference#drawbox)
## [u8g.disp:drawCircle()](https://github.com/olikraus/u8glib/wiki/userreference#drawcircle) ## [u8g.disp:drawCircle()](https://github.com/olikraus/u8glib/wiki/userreference#drawcircle)
@ -277,24 +271,20 @@ Bitmaps and XBMs are supplied as strings to `drawBitmap()` and `drawXBM()`. This
`disp:drawXBM(x, y, w, h, bitmap)` `disp:drawXBM(x, y, w, h, bitmap)`
#### Parameters #### Parameters
- `x`: X-position (left position of the bitmap). - `x`: X-position (left position of the bitmap)
- `y`: Y-position (upper position of the bitmap). - `y`: Y-position (upper position of the bitmap)
- `w`: Width of the bitmap. - `w`: Width of the bitmap
- `h`: Height of the bitmap. - `h`: Height of the bitmap
- `bitmap`: XBM data supplied as string. - `bitmap`: XBM data supplied as string
#### Returns #### Returns
`nil` `nil`
#### Example
`lua_examples/u8glib/u8g_bitmaps.lua`
#### See also #### See also
- [u8glib drawXBM()](https://github.com/olikraus/u8glib/wiki/userreference#drawxbm) - [u8glib drawXBM()](https://github.com/olikraus/u8glib/wiki/userreference#drawxbm)
- [lua_examples/u8glib/u8g_bitmaps.lua](https://github.com/nodemcu/nodemcu-firmware/blob/master/lua_examples/u8glib/u8g_bitmaps.lua)
- [u8g.disp:drawBitmap()](#u8gdispdrawbitmap) - [u8g.disp:drawBitmap()](#u8gdispdrawbitmap)
___
## [u8g.disp:firstPage()](https://github.com/olikraus/u8glib/wiki/userreference#firstpage) ## [u8g.disp:firstPage()](https://github.com/olikraus/u8glib/wiki/userreference#firstpage)
## [u8g.disp:getColorIndex()](https://github.com/olikraus/u8glib/wiki/userreference#getcolorindex) ## [u8g.disp:getColorIndex()](https://github.com/olikraus/u8glib/wiki/userreference#getcolorindex)
@ -334,7 +324,7 @@ They'll be available as `u8g.<font_name>` in Lua.
`disp:setFont(font)` `disp:setFont(font)`
#### Parameters #### Parameters
- `font`: Constant to indentify pre-compiled font. - `font`: Constant to indentify pre-compiled font
#### Returns #### Returns
`nil` `nil`
@ -347,8 +337,6 @@ disp:setFont(u8g.font_6x10)
#### See also #### See also
- [u8glib setFont()](https://github.com/olikraus/u8glib/wiki/userreference#setfont) - [u8glib setFont()](https://github.com/olikraus/u8glib/wiki/userreference#setfont)
___
## [u8g.disp:setFontLineSpacingFactor()](https://github.com/olikraus/u8glib/wiki/userreference#setfontlinespacingfactor) ## [u8g.disp:setFontLineSpacingFactor()](https://github.com/olikraus/u8glib/wiki/userreference#setfontlinespacingfactor)
## [u8g.disp:setFontPosBaseline()](https://github.com/olikraus/u8glib/wiki/userreference#setfontposbaseline) ## [u8g.disp:setFontPosBaseline()](https://github.com/olikraus/u8glib/wiki/userreference#setfontposbaseline)

10
docs/en/modules/ucg.md
View File

@ -83,12 +83,12 @@ Initialize a display via Hardware SPI.
`ucg.st7735_18x128x160_hw_spi(cs, dc, res)` `ucg.st7735_18x128x160_hw_spi(cs, dc, res)`
#### Parameters #### Parameters
- `cs`: GPIO pin for /CS. - `cs`: GPIO pin for /CS
- `dc`: GPIO pin for DC. - `dc`: GPIO pin for DC
- `res`: GPIO pin for /RES (optional). - `res`: GPIO pin for /RES (optional)
#### Returns #### Returns
ucg display object. ucg display object
#### Example #### Example
```lua ```lua
@ -189,7 +189,7 @@ disp:setFont(ucg.font_7x13B_tr)
``` ```
#### See also #### See also
- [ucglib setFont()](https://github.com/olikraus/ucglib/wiki/reference#setfont) [ucglib setFont()](https://github.com/olikraus/ucglib/wiki/reference#setfont)
## [ucg.disp:setFontMode()](https://github.com/olikraus/ucglib/wiki/reference#setfontmode) ## [ucg.disp:setFontMode()](https://github.com/olikraus/ucglib/wiki/reference#setfontmode)