diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000000000000000000000000000000000000..cd66a79726ecac431857f815ab72b94c48f3aa9e --- /dev/null +++ b/README.en.md @@ -0,0 +1,26 @@ +This project is a firmware application designed for the MindMotion MM32F0121 microcontroller. It integrates various hardware peripherals and communication protocols to enable functionalities such as Wi-Fi connectivity via the ESP8266 module, OLED display control, LED and servo PWM control, and JSON data handling. + +### Key Features +- **Wi-Fi Connectivity**: Uses the ESP8266 module for connecting to Wi-Fi networks and handling MQTT communication. +- **OLED Display**: Provides functions to control an OLED display via I2C for showing characters, strings, and numeric data. +- **LED and Servo Control**: Includes utilities for LED toggling and servo motor control using PWM signals. +- **Delay and Timing**: Implements millisecond-level delays using the SysTick timer. +- **JSON Handling**: Uses the cJSON library to parse and generate JSON data for communication and configuration purposes. + +### Components +- **CMSIS**: ARM Cortex Microcontroller Software Interface Standard, providing low-level device support. +- **MM32Libs**: MindMotion standard peripheral library for the MM32 series microcontrollers. +- **HardLibs**: Hardware abstraction layer for components like ESP8266, OLED, LEDs, and onboard peripherals. +- **Utils**: Utility functions for delay, PWM control, console output, and JSON manipulation. + +### Usage +The project initializes the system clock and various peripherals in the `main()` function. It sets up the ESP8266 for MQTT communication, initializes the OLED display, and configures LED and servo PWM outputs. The main loop handles user input and updates the display accordingly. + +### Build Environment +The project is built using the Keil MDK-ARM toolchain, with project configuration files included for easy setup and compilation. + +### License +This project uses components with licenses such as the Apache License 2.0 and MIT License. Please refer to individual files for specific licensing details. + +### Contributing +Contributions are welcome! Please ensure you understand the project structure and licensing before submitting pull requests. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000000000000000000000000000000000000..cd66a79726ecac431857f815ab72b94c48f3aa9e --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +This project is a firmware application designed for the MindMotion MM32F0121 microcontroller. It integrates various hardware peripherals and communication protocols to enable functionalities such as Wi-Fi connectivity via the ESP8266 module, OLED display control, LED and servo PWM control, and JSON data handling. + +### Key Features +- **Wi-Fi Connectivity**: Uses the ESP8266 module for connecting to Wi-Fi networks and handling MQTT communication. +- **OLED Display**: Provides functions to control an OLED display via I2C for showing characters, strings, and numeric data. +- **LED and Servo Control**: Includes utilities for LED toggling and servo motor control using PWM signals. +- **Delay and Timing**: Implements millisecond-level delays using the SysTick timer. +- **JSON Handling**: Uses the cJSON library to parse and generate JSON data for communication and configuration purposes. + +### Components +- **CMSIS**: ARM Cortex Microcontroller Software Interface Standard, providing low-level device support. +- **MM32Libs**: MindMotion standard peripheral library for the MM32 series microcontrollers. +- **HardLibs**: Hardware abstraction layer for components like ESP8266, OLED, LEDs, and onboard peripherals. +- **Utils**: Utility functions for delay, PWM control, console output, and JSON manipulation. + +### Usage +The project initializes the system clock and various peripherals in the `main()` function. It sets up the ESP8266 for MQTT communication, initializes the OLED display, and configures LED and servo PWM outputs. The main loop handles user input and updates the display accordingly. + +### Build Environment +The project is built using the Keil MDK-ARM toolchain, with project configuration files included for easy setup and compilation. + +### License +This project uses components with licenses such as the Apache License 2.0 and MIT License. Please refer to individual files for specific licensing details. + +### Contributing +Contributions are welcome! Please ensure you understand the project structure and licensing before submitting pull requests. \ No newline at end of file