https://github.com/marlinfirmware/u8glib-hal

Customized U8glib for use in Marlin 2.0
https://github.com/marlinfirmware/u8glib-hal

3d-printing firmware lcd-display library reprap

Last synced: 2 months ago
JSON representation

Customized U8glib for use in Marlin 2.0

• Host: GitHub
• URL: https://github.com/marlinfirmware/u8glib-hal
• Owner: MarlinFirmware
• License: other
• Created: 2017-11-07T05:08:16.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-04-25T05:32:43.000Z (9 months ago)
• Last Synced: 2024-05-01T09:50:28.889Z (9 months ago)
• Topics: 3d-printing, firmware, lcd-display, library, reprap
• Language: C
• Homepage:
• Size: 3.5 MB
• Stars: 44
• Watchers: 7
• Forks: 33
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# U8glib-HAL

u8g by Oliver Kraus with extensions for ARM and the Marlin HAL.

The extensions allow access to the u8g library by "non native" CPUs/systems.

AVR, Arduino, and Due access to the library is not changed.

Enabling the extensions by defining the flag **`U8G_HAL_LINKS`**. This can be done in `platformio.ini` by adding **`-DU8G_HAL_LINKS`** to any environment's build flags.

### The following files provide the links between the u8g library and the "non native" CPUs/systems.

#### `#include `

The `LCD_defines.h` header brings in the top level link file which:

- Defines link files for SPI routines, delay routines, I2C routines and class definitions.

- Connects u8g com generic com defines to the desired HAL com routine.

#### `#include `

Contains code or declarations for the u8g routines:

- `void U8g_delay(int msec)`

- `void u8g_MicroDelay(void)`

- `void u8g_10MicroDelay(void)`

#### `#include `

Contains code or declarations for the u8g routines:

- `void u8g_SetPinOutput(uint8_t internal_pin_number)`

- `void u8g_SetPinInput(uint8_t internal_pin_number)`

- `void u8g_SetPinLevel(uint8_t  pin, uint8_t  pin_status)`

- `uint8_t u8g_GetPinLevel(uint8_t pin)`

#### `#include `

Contains code or declarations for the u8g routines:

- `void u8g_i2c_init(uint8_t options)`

- `uint8_t u8g_i2c_wait(uint8_t mask, uint8_t pos)`

- `uint8_t u8g_i2c_start(uint8_t sla)`

- `uint8_t u8g_i2c_send_byte(uint8_t data)`

- `void u8g_i2c_stop(void)`

#### MarlinFirmware Changes

- Empty constructors are now provided so the u8g instance can be initialized later.

  Data members are still constructed early when the u8g object is declared static global.

- Constructors that just take an "options" argument now *require* the argument (e.g., `U8G_I2C_OPT_NONE`) or they will be treated as default empty constructors and won't be initialized.