Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V1.0.0 soft fixes #24

Merged
merged 2 commits into from
Jan 23, 2024
Merged

V1.0.0 soft fixes #24

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec0e6c1
ReadMe: readme file update
niwciu Jan 22, 2024
f419352
Test: update file after Cppcheck
niwciu Jan 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 19 additions & 16 deletions ReadMe.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
- [Hardware configuration and connections](#hardware-configuration-and-connections-1)
- [LCD\_HD44780 library configuration - lcd\_hd44780\_config.h](#lcd_hd44780-library-configuration---lcd_hd44780_configh-2)
- [How to build and run the example](#how-to-build-and-run-the-example-2)
- [4. ESP8266 NONOS SDK - TBD ...](#4-esp8266-nonos-sdk---tbd-)
- [4. ESP8266 NONOS SDK](#4-esp8266-nonos-sdk)
- [Requirements](#requirements)
- [Hardware connections](#hardware-connections)
- [LCD\_HD44780 library configuration - lcd\_hd44780\_config.h](#lcd_hd44780-library-configuration---lcd_hd44780_configh-3)
Expand All @@ -53,7 +53,7 @@
- int format
- hex format
- bin format
- The library has currently predefined LCD types:
- The library has currently predefined following LCD types:
- 2 lines 16 characters (1602)
- 4 lines 16 characters (1604)
- 4 lines 20 characters (2004)
Expand Down Expand Up @@ -86,11 +86,12 @@ LCD_HD44780
- LCD type
- Usage of RW Signal/PIN
- Usage of LCD buffer for displaying the content on the LCD
- Backlight enable pin active state
- Which functions from LCD_HD44780 lib you would like to compile and use in your project.
#### 2. lcd_hd44780_def_char.h
Header file for defining user special characters and user special characters banks. Each bank can contain up to 8 characters that are user-defined combinations of characters from defined user-special characters. This allows to creation of different combinations of special characters that can be loaded depending on current code needs.
#### 3. lcd_hd44780_interface.h
Header file with library interface declaration that needs to be implemented on the drivers' side. Please look at the code examples in the "examples" folder and search for the "LCD_IO_driver.c" file for more details.
Header file with library interface declaration that needs to be implemented on the drivers' side. Please look at the code examples in the "examples/lcd_driver_intrface_example_implementations" for more details.
#### 4. lcd_hd44780.c
Library main C file
#### 5. lcd_hd44780.h
Expand All @@ -102,7 +103,7 @@ Library main header file with available library functions.
2. Make or Ninja installed
3. ARM GNU Toolchain (gcc-arm-none-eabi) installed
4. STM32_Programmer_CLI installed
5. ST-link (on Nucleo Board) installed
5. ST-link (placed on Nucleo Board) installed
#### Hardware requirements, configuration, and connections
1. STM32G071 Nucleo-64<br>
<img src="./examples/doc/STM32G071RB_Nucleo.png" width="400"><br> <br>
Expand Down Expand Up @@ -161,7 +162,7 @@ Library main header file with available library functions.
```bash
cd ./LCD_HD44780/examples/STM32G071RB
```
4. For make type:
4. For Make type:
```bash
cmake -S ./ -B Debug -G"Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug
```
Expand Down Expand Up @@ -195,7 +196,7 @@ Library main header file with available library functions.
2. Make or Ninja installed
3. ARM GNU Toolchain (gcc-arm-none-eabi) installed
4. STM32_Programmer_CLI installed
5. ST-link (on Nucleo Board) installed
5. ST-link (placed on Nucleo Board) installed
#### Hardware configuration and connections
1. STM32G474 Nucleo-64<br>
<img src="./examples/doc/STM32G474RE_Nucleo.png" width="400"><br> <br>
Expand Down Expand Up @@ -254,7 +255,7 @@ Library main header file with available library functions.
```bash
cd ./LCD_HD44780/examples/STM32G474RB
```
4. For make type:
4. For Make type:
```bash
cmake -S ./ -B Debug -G"Unix Makefiles" -DCMAKE_BUILD_TYPE=Debug
```
Expand Down Expand Up @@ -348,7 +349,7 @@ Library main header file with available library functions.
```bash
cd ./LCD_HD44780/examples/ATMEGA328P_ARDUINO_UNO_R3
```
4. For make type:
4. For Make type:
```bash
cmake -S ./ -B Build -G"Unix Makefiles"
```
Expand Down Expand Up @@ -381,7 +382,7 @@ Library main header file with available library functions.
ninja flash
```

### 4. ESP8266 NONOS SDK - TBD ...
### 4. ESP8266 NONOS SDK
#### Requirements
1. Make installed
2. ESP Toolchain installed according to esspresif doc
Expand All @@ -390,7 +391,7 @@ Library main header file with available library functions.
- For Linux: <br>
https://docs.espressif.com/projects/esp8266-rtos-sdk/en/latest/get-started/linux-setup.html
3. Downloaded Flash Download Tool V3.8.5
4. ESP8266 node mcu V3 installed
4. ESP8266 NodeMCU V3 installed
#### Hardware connections
1. ESP8266 NodeMCU V3<br>
<img src="./examples/doc/ESP8266_NodeMCU_V3.png" width="400"><br> <br>
Expand Down Expand Up @@ -442,29 +443,29 @@ Library main header file with available library functions.
#### How to build and run the example
##### Windows
1. Open the location you want to clone the repository to in your terminal
2. Clone the repository to your preferred localization
2. Clone the repository to your preferred location
```bash
git clone https://github.com/niwciu/LCD_HD44780.git
```
3. Enter to LCD_HD44780/examples/ESP8266_NONOS_SDK/LCD_HD44780_TEST folder
```bash
cd ./LCD_HD44780/examples/ESP8266_NONOS_SDK/LCD_HD44780_TEST
```
4. Clean the project running clean.bat script
4. Clean the project by running clean.bat script
```bash
./clean.bat
```
5. Build the project running build.bat script
5. Build the project by running build.bat script
```bash
./build.bat
```
6. Run flash_download_tool_3.8.5
7. Select "Developer Mode" and "ESP8266 DownloadTool" in next window
7. Select "Developer Mode" and "ESP8266 DownloadTool"
8. Set all fields as it is shown on picture bellow<br>
<img src="./examples/doc/ESP_download_tool_setup.png" width="900"><br> <br>
9. Select COM port on which your NodeMCU board has been installed
10. Click START to flash the IC
11. After Flash is done pres reset button on your NodeMCU board
11. After flash is done pres reset button on your NodeMCU board
##### Linux - tbd
## How to use in your Project - simple case without user-predefined characters
1. Copy LCD library src files (or files from src folder) to your project.
Expand Down Expand Up @@ -673,6 +674,7 @@ LCD_HD44780
│ ├───ATMEGA328P_ARDUINO_UNO_R3
│ ├───config
│ ├───doc
│ ├───ESP8266_NONOS_SDK
│ ├───lcd_driver_intrface_example_implementations
│ └───STM32G071RB_NUCLEO_BARE_METAL
│ └───STM32G474RE_NUCLEO_CUBE_IDE_LL
Expand All @@ -694,7 +696,8 @@ Folder description:
- examples -> folder with example hardware implementations contain ready to compile examples for different uC and templates of lcd_driver_interface implementations.
- ATMEGA328P_ARDUINO_UNO_R3 -> example project
- config -> tollchain files
- doc -> documentation of used hardware in examples
- doc -> files used for examples documentation
- ESP8266_NONOS_SDK -> example project
- lcd_driver_intrface_example_implementations -> as named
- STM32G071RB_NUCLEO_BARE_METAL -> example project
- STM32G474RE_NUCLEO_CUBE_IDE_LL -> example project
Expand Down
4 changes: 2 additions & 2 deletions test/lcd_hd44780/lcd_hd44780_test_runner.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ TEST_GROUP_RUNNER(lcd_hd44780_init)
/* Test cases to run */
RUN_TEST_CASE(lcd_hd44780_init, WhenLcdInitThenLcdDataSignalBcklPinsInit);
RUN_TEST_CASE(lcd_hd44780_init, WhenLcdInitThenLcdDataPinsLowAtFirstLog);
RUN_TEST_CASE(lcd_hd44780_init, GivenLcdInitWhenSetLcdBacklightOffThenLcdPinStatIsCorrect)
RUN_TEST_CASE(lcd_hd44780_init, GivenLcdInitWhenSetLcdBacklightOffThenLcdPinStatIsCorrect);
RUN_TEST_CASE(lcd_hd44780_init, GivenLcdInitWhenSetAllSignalsFor15msThenLcdPinStatIsCorrect);
RUN_TEST_CASE(lcd_hd44780_init, GivenLcdInitWhenSendFirstCmd0x03ThenLcdPinStateSequenceIsCorrect);
RUN_TEST_CASE(lcd_hd44780_init, GivenLcdInitWhenSendSecondCmd0x03ThenLcdPinStateSequenceIsCorrect);
Expand All @@ -16,7 +16,7 @@ TEST_GROUP_RUNNER(lcd_hd44780_init)
RUN_TEST_CASE(lcd_hd44780_init, GivenLcdInitWhenSendDisplaySettingsCmdThenLcdPinStateSequenceIsCorrect);
RUN_TEST_CASE(lcd_hd44780_init, GivenLcdInitWhenSendDisplayClearScrCmdThenLcdPinStateSequenceIsCorrect);
RUN_TEST_CASE(lcd_hd44780_init, GivenLcdInitWhenSendDisplayEntryModeCmdThenLcdPinStateSequenceIsCorrect);
RUN_TEST_CASE(lcd_hd44780_init, WhenLcdInitThenLcdBackLightisOff)
RUN_TEST_CASE(lcd_hd44780_init, WhenLcdInitThenLcdBackLightisOff);

// RUN_TEST_CASE(lcd_hd44780_init, )
}
Expand Down
Loading