SDK V1.0.6 Docs
GR533x SDK V1.0.6 documentation aims to help developers to understand and use GR533x SoCs quickly and comprehensively.
Getting Started
| Document Name | Version | Description |
|---|---|---|
| Getting Started with Bluetooth LE Device | Latest | Helps users quickly get started with Goodix Bluetooth Low Energy SoCs. |
SDK User Guide
| Document Name | Version | Description |
|---|---|---|
| GR533x Developer Guide | 1.2 | Introduces the Software Development Kit (SDK) of the Goodix GR533x Bluetooth Low Energy (Bluetooth LE) System-on-Chip (SoC) and Keil for program development and debugging. |
| GR533x LCP Developer Guide | 1.0 | Introduces the data packet format and application model of GR533x Light Communication Protocol (LCP, a Goodix 2.4 GHz proprietary protocol), to help users quickly get started with development of LCP-based communication applications |
| GR5xx GCC User Manual | 1.0 | Introduces the methods to establish integrated development environments (IDEs) for cross compilation of GR5xx System-on-Chips (SoCs) in command-line interface with GNU Compiler Collection (GCC) and makefiles on Linux and Windows. |
| GR5xx IAR User Manual | 1.0 | Introduces the methods to develop and to debug GR5xx Bluetooth Low Energy (Bluetooth LE) applications based on IAR Embedded Workbench IDE. |
| GR5xx APP Driver User Manual | 1.4 | Introduces the architecture, API classification, parameter structure, and common configurations of the APP_DRV (Application Driver) peripheral module driver, as well as the usage method of the APP_DRV driver and example projects for some modules. |
API Reference
| Document Name | Version | Description |
|---|---|---|
| GR5xx API Reference | 1.0.6 | Describes the APIs for developing Bluetooth LE applications and other applications. |
SDK Example Files
| Document Name | Version | Description |
|---|---|---|
| GR5xx HRS RSCS Relay Example Application | 3.1 | Introduces how to use and verify a Heart Rate Sensor & Running Speed and Cadence Sensor Relay (HRS RSCS Relay) example in GR5xx SDK. |
| GR5xx ANCS Profile Example Application | 3.1 | Introduces how to use and verify the ANCS example in GR5xx SDK. |
| GR5xx FreeRTOS Example Application | 3.1 | Introduces how to use and modify a FreeRTOS example in GR5xx SDK. |
| GR5xx Power Consumption Profile Example Application | 3.1 | Introduces how to use and verify a power consumption measurement example in GR5xx SDK. |
| GR5xx Serial Port Profile Example Application | 3.1 | Introduces how to use and verify the Serial Port Profile (SPP) example in GR5xx SDK. |
| GR5xx HID Mouse Example Application | 3.2 | Introduces how to run Human Input Device (HID) Service and Bluetooth Low Energy (Bluetooth LE) GR5xx HID mouse example for the first time and its application details. |
| GR5xx Sample Service Application and Customization | 3.1 | Introduces how to use and verify the sample service example in GR5xx SDK. |
| GR5xx AMS Profile Example Application | 3.1 | Introduces how to use and verify the AMS Client example in Bluetooth LE GR5xx SDK. |
| GR5xx Throughput Example Application | 3.1 | Introduces how to use and verify a throughput example in GR5xx SDK. |
| GR5xx AT Command Example Application | 3.1 | Introduces how to use and verify the ble_app_uart_at example in GR5xx SDK. |
SDK Application Notes
| Document Name | Version | Description |
|---|---|---|
| GR5xx DFU Development Application Note | 1.4 | Introduces the principles of Device Firmware Upgrade (DFU), GR5xx DFU solution design, App bootloader application, and the method for firmware upgrade using GRToolbox (Android) APP and DFU Master. |
| GR533x Power Consumption Measurement User Guide | 1.3 | Introduces the features of each GR533x power mode, explains how to measure power consumption in different scenarios, and provides reference measurement results. |
| GR5xx DTM Test Application Note | 3.3 | Introduces the test framework and test methods of Direct Test Mode (DTM) in Bluetooth Low Energy (Bluetooth LE) applications. It describes how to use a Bluetooth tester and DTMTool (an RF test tool) to test the radio frequency (RF) performances of GR5xx System-on-Chips (SoCs) and demonstrates a GR5xx DTM example. |
| GR5xx Fault Trace Module Application Note | 3.2 | Introduces the functionalities, operating mechanisms, and applications of GR5xx Fault Trace Module. |
| GR5xx APP Log Application Note | 3.2 | Introduces the functionalities, operating mechanisms, and applications of APP Log module in GR5xx SDK. |
Mesh Examples
| Document Name | Version | Description |
|---|---|---|
| GR533x Mesh Simple On Off Models Example Application | 1.1 | Provides an overview of the operation, verification, and critical code of the Light Lightness Models examples in GR533x SDK. |
| GR533x Mesh Simple On Off Models Example Application | 1.1 | Provides an overview of the operation, verification, and critical code of the Simple On Off Models examples in GR533x SDK. |
Tool Documents
| Document Name | Version | Description |
|---|---|---|
| GProgrammer User Manual | 3.1 | Introduces how to install GProgrammer and operate its functional modules. |