GitHub/nodemcu-firmware
1
0
Fork 0
mirror of https://github.com/nodemcu/nodemcu-firmware.git synced 2025-01-30 21:12:55 +08:00
Code Issues Projects Releases Wiki Activity

transferred ucg module documentation

Browse Source
This commit is contained in:
devsaurus 2016-01-09 00:57:07 +01:00
parent 008c17ef7d
commit c69ea9b2a5
2 changed files with 14 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -26,7 +26,7 @@ SPI only:
This integration is based on [v1.18.1](https://github.com/olikraus/U8glib_Arduino/releases/tag/1.18.1). This integration is based on [v1.18.1](https://github.com/olikraus/U8glib_Arduino/releases/tag/1.18.1).
## Description ## Overview
### I2C Connection ### I2C Connection
Hook up SDA and SCL to any free GPIOs. Eg. [u8g_graphics_test.lua](https://github.com/nodemcu/nodemcu-firmware/blob/master/lua_examples/u8glib/u8g_graphics_test.lua) expects SDA=5 (GPIO14) and SCL=6 (GPIO12). They are used to set up nodemcu's I2C driver before accessing the display: Hook up SDA and SCL to any free GPIOs. Eg. [u8g_graphics_test.lua](https://github.com/nodemcu/nodemcu-firmware/blob/master/lua_examples/u8glib/u8g_graphics_test.lua) expects SDA=5 (GPIO14) and SCL=6 (GPIO12). They are used to set up nodemcu's I2C driver before accessing the display:
```lua ```lua
@ -112,7 +112,7 @@ 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.
@ -215,11 +215,11 @@ 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`
@ -277,11 +277,11 @@ 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`
@ -334,7 +334,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`

1
mkdocs.yml
View File

@ -43,5 +43,6 @@ pages:
- 'tmr': 'en/modules/tmr.md' - 'tmr': 'en/modules/tmr.md'
- 'u8g': 'en/modules/u8g.md' - 'u8g': 'en/modules/u8g.md'
- 'uart': 'en/modules/uart.md' - 'uart': 'en/modules/uart.md'
- 'ucg': 'en/modules/ucg.md'
- Deutsch: - Deutsch:
- Home: 'de/index.md' - Home: 'de/index.md'