Kontekst AI
Ta strona zawiera pełne API w jednym miejscu — idealne do skopiowania jako kontekst dla AI.
Jak użyć
- Otwórz plik
doc_generated/_full_api_context.md w edytorze (lub na tej stronie poniżej)
- Skopiuj całą zawartość
- Wklej jako kontekst w ChatGPT / Claude / Copilot
Wskazówka
Plik jest generowany automatycznie przy każdym buildzie dokumentacji.
Zawiera wszystkie tabele API w formacie Markdown — czytelnym zarówno dla ludzi jak i AI.
Pełna zawartość
nRF53 Universal — BLE API Reference (auto-generated)
Ten plik jest generowany automatycznie z kodu źródłowego.
Możesz go wrzucić jako kontekst do ChatGPT / Claude / Copilot.
Moduły (module_id)
| Moduł |
ID |
Opis |
MODULE_SYSTEM |
0 |
|
MODULE_ACC_GYRO |
2 |
|
MODULE_BAROMETER |
3 |
|
MODULE_BATTERY |
4 |
|
MODULE_GNSS |
5 |
|
MODULE_MAGNETOMETER |
6 |
|
MODULE_SELECTOR |
7 |
|
MODULE_TRIGGER |
8 |
|
MODULE_QUATERNION |
9 |
|
MODULE_PLAYER_STATE |
10 |
|
MODULE_UI |
11 |
|
MODULE_KICKBACK |
12 |
|
Typy komend (command)
| Komenda |
Wartość |
Opis |
CONTROL_CMD_SET |
1 |
|
CONTROL_CMD_GET |
2 |
|
Kody statusu (reply)
| Status |
Wartość |
Opis |
CONTROL_STATUS_OK |
1 |
|
CONTROL_STATUS_UNKNOWN_ERROR |
2 |
|
CONTROL_STATUS_NOT_CALIBRATED |
3 |
|
CONTROL_STATUS_UNKNOWN_COMMAND |
4 |
|
CONTROL_STATUS_UNSUPPORTED_KEY |
5 |
Moduł nie obsługuje tego klucza |
CONTROL_STATUS_INVALID_VALUE |
6 |
Wartość poza zakresem / niepoprawna |
CONTROL_STATUS_BUSY |
7 |
Operacja w toku (np. kalibracja) |
CONTROL_STATUS_NOT_READY |
8 |
Moduł nie zainicjalizowany |
CONTROL_STATUS_HARDWARE_ERROR |
9 |
Błąd sprzętowy (np. I2C/SPI) |
Klucze uniwersalne (0x01–0x3F)
| Klucz |
Wartość |
Opis |
KEY_MODULE_ENABLE |
0x01 |
SET value=1: włącz moduł, value=0: wyłącz moduł. GET: zwraca bieżący stan (1=włączony, 0=wyłączony). |
KEY_MODULE_INFO |
0x02 |
GET only — zwraca informacje o module (wersja sensora, capabilities). Format odpowiedzi jest zależny od modułu. |
KEY_CALIB_START |
0x10 |
SET only — rozpocznij interaktywną sesję kalibracji. Moduł przechodzi w stan kalibracji. Sesję kończy COMMIT lub ABORT. Zwraca BUSY jeśli sesja już trwa. |
KEY_CALIB_ABORT |
0x11 |
SET only — przerwij sesję kalibracji, przywróć poprzednią konfigurację. |
KEY_CALIB_CAPTURE |
0x12 |
SET value=step_index — zarejestruj punkt/próbkę kalibracyjną. Dotyczy kalibracji interaktywnej (np. selector: step 0..3). |
KEY_CALIB_COMMIT |
0x13 |
SET only — zakończ sesję kalibracji, oblicz i zastosuj wyniki. Automatycznie zapisuje do NVS. |
KEY_CALIB_GET |
0x14 |
GET only — zwraca pełny blob danych kalibracyjnych. Format zależy od modułu (np. magnetometr: hard_iron + soft_iron). |
KEY_CALIB_SET |
0x15 |
SET value=blob — zapisz pełne dane kalibracyjne (import z zewnątrz). Automatycznie zapisuje do NVS. |
KEY_CALIB_STATUS |
0x16 |
GET only — zwraca status kalibracji. value[0]: 0 = brak kalibracji (defaults), 1 = skalibrowany. Dodatkowe bajty zależne od modułu (np. quality metric). |
KEY_SYS_FW_VERSION |
0x20 |
GET only — wersja firmware (string, null-terminated). |
KEY_SYS_UPTIME |
0x21 |
GET only — uptime w sekundach (uint32_t LE). |
KEY_SYS_LAST_ERROR |
0x22 |
GET only — ostatni błąd (serialized error_t). |
KEY_SYS_FACTORY_RESET |
0x23 |
SET only — factory reset (wymaż NVS, reboot). value[0] = 0xA5 (magic byte, ochrona przed przypadkowym wywołaniem). |
KEY_SYS_ERROR_LOG |
0x24 |
GET only — flush kolejki błędów via NOTIFY. Reply value[0] = liczba błędów w kolejce. Błędy przychodzą jako data_frame z FLAG_ERROR. |
Klucze moduł-specyficzne (0x40–0xFF)
| Klucz |
Wartość |
Moduł |
Opis |
KEY_GNSS_UPDATE_RATE |
0x40 |
GNSS (MODULE_GNSS = 5) |
SET/GET — częstotliwość aktualizacji pozycji [Hz, uint8_t, 1–20]. |
KEY_GNSS_DYNAMIC_MODEL |
0x41 |
GNSS (MODULE_GNSS = 5) |
SET/GET — model dynamiczny UBX (uint8_t, 0=portable…8=bike). |
KEY_AG_RANGE |
0x40 |
Acc/Gyro (MODULE_ACC_GYRO = 2) |
SET/GET — zakres pomiarowy. SET: value[0]=lsm6dsv32x_range_acc_t, value[1]=lsm6dsv32x_range_gyro_t. GET: identyczny format. |
KEY_AG_ODR |
0x41 |
Acc/Gyro (MODULE_ACC_GYRO = 2) |
SET/GET — ODR (Output Data Rate). value[0]=lsm6dsv32x_odr_t, value[1]=lsm6dsv32x_haodr_sel_t. |
KEY_BARO_OSR |
0x40 |
Barometer (MODULE_BAROMETER = 3) |
SET/GET — oversampling (OSR). value[0]=bmp581_osr_t (ciśnienie), value[1]=bmp581_osr_t (temperatura). |
KEY_BARO_IIR |
0x41 |
Barometer (MODULE_BAROMETER = 3) |
SET/GET — filtr IIR. value[0]=bmp581_iir_t. |
KEY_TRIGGER_SENSITIVITY |
0x40 |
Trigger (MODULE_TRIGGER = 8) |
SET/GET — czułość triggera (uint8_t, 1–8). |
KEY_TRIGGER_MODE |
0x41 |
Trigger (MODULE_TRIGGER = 8) |
SET/GET — tryb triggera (uint8_t, trigger_mode_t). |
KEY_TRIGGER_BASES |
0x42 |
Trigger (MODULE_TRIGGER = 8) |
GET only — bazowe wartości Z sensorów (int16_t LE × 2 = 4B). |
KEY_SELECTOR_HYSTERESIS |
0x40 |
Selector (MODULE_SELECTOR = 7) |
SET/GET — próg histerezy Manhattan (uint8_t). |
KEY_KICKBACK_TIMING |
0x40 |
Kickback (MODULE_KICKBACK = 12) |
SET/GET — parametry czasowe kickbacka. value[0]=on_time_ms (uint8_t), value[1]=off_time_ms (uint8_t). |
Stałe Data Frame
| Stała |
Wartość |
Opis |
DATA_FRAME_HEADER_SIZE |
12 |
|
DATA_FRAME_PAYLOAD_MIN |
1 |
|
DATA_FRAME_PAYLOAD_MAX |
232 |
|
DATA_FRAME_MODULE_ID_INDEX |
0 |
|
DATA_FRAME_FLAGS_INDEX |
1 |
|
DATA_FRAME_FRAME_NUMBER_INDEX |
2 |
|
DATA_FRAME_SAMPLE_COUNT_INDEX |
3 |
|
DATA_FRAME_TIMESTAMP_FIRST_INDEX |
4 |
|
DATA_FRAME_TIMESTAMP_LAST_DELTA_INDEX |
9 |
|
DATA_FRAME_PAYLOAD_INDEX |
12 |
|
Błędy — Poziom
| Poziom |
Wartość |
Opis |
ERROR_LEVEL_NONE |
0 |
|
ERROR_LEVEL_WARNING |
1 |
|
ERROR_LEVEL_CRITICAL |
2 |
|
Błędy — Źródło
| Źródło |
Wartość |
Opis |
ERROR_SOURCE_NONE |
0 |
|
ERROR_SOURCE_PERIPHERAL_ADC |
1 |
|
ERROR_SOURCE_PERIPHERAL_BLE |
2 |
|
ERROR_SOURCE_PERIPHERAL_GPIO |
3 |
|
ERROR_SOURCE_PERIPHERAL_GPIOTE |
4 |
|
ERROR_SOURCE_PERIPHERAL_PWM |
5 |
|
ERROR_SOURCE_PERIPHERAL_UART |
6 |
|
ERROR_SOURCE_PERIPHERAL_I2C |
7 |
|
ERROR_SOURCE_PERIPHERAL_SPI |
8 |
|
ERROR_SOURCE_PERIPHERAL_STORAGE |
9 |
|
ERROR_SOURCE_MODULE_ACC_GYRO |
102 |
|
ERROR_SOURCE_MODULE_BAROMETER |
103 |
|
ERROR_SOURCE_MODULE_BATTERY |
104 |
|
ERROR_SOURCE_MODULE_GNSS |
105 |
|
ERROR_SOURCE_MODULE_MAGNETOMETER |
106 |
|
ERROR_SOURCE_MODULE_SELECTOR |
107 |
|
ERROR_SOURCE_MODULE_TRIGGER |
108 |
|
ERROR_SOURCE_MODULE_QUATERNION |
109 |
|
ERROR_SOURCE_MODULE_PLAYER_STATE |
110 |
|
ERROR_SOURCE_MODULE_LED |
111 |
|
ERROR_SOURCE_MODULE_BUZZER |
112 |
|
ERROR_SOURCE_MODULE_KICKBACK |
113 |
|
Błędy — Przyczyna
| Przyczyna |
Wartość |
Opis |
ERROR_REASON_NONE |
0 |
|
ERROR_REASON_COMMUNICATION_FAILED |
1 |
|
ERROR_REASON_EXTERNAL_MAGNETIC_FIELD |
2 |
|
ERROR_REASON_INITIALIZATION_FAILED |
3 |
|
ERROR_REASON_INVALID_CONFIGURATION |
4 |
|
ERROR_REASON_LOW_LEVEL |
5 |
|
ERROR_REASON_OUT_OF_RANGE |
6 |
|
ERROR_REASON_SENSOR_FAILURE |
7 |
|
ERROR_REASON_TIMEOUT |
8 |
|
ERROR_REASON_VOLTAGE_TOO_HIGH |
9 |
|
ERROR_REASON_VOLTAGE_TOO_LOW |
10 |
|
ERROR_REASON_CONFIGURATION_ERROR |
11 |
|
Błędy — Model sensora
| Model sensora |
Wartość |
Opis |
ERROR_SENSOR_MODEL_NONE |
0 |
|
ERROR_SENSOR_MODEL_BMP581 |
1 |
|
ERROR_SENSOR_MODEL_IN_S66TBTRGB |
2 |
|
ERROR_SENSOR_MODEL_LSM6DSV32X |
3 |
|
ERROR_SENSOR_MODEL_MMC5983MA |
4 |
|
ERROR_SENSOR_MODEL_TMAG5273A1 |
5 |
|
ERROR_SENSOR_MODEL_TMAG5273B1 |
6 |
|
ERROR_SENSOR_MODEL_TMAG5273C1 |
7 |
|
ERROR_SENSOR_MODEL_TMAG5273D1 |
8 |
|
ERROR_SENSOR_MODEL_ZED_F9P_05B |
9 |
|
Błędy — Typ szczegółu
| Typ szczegółu |
Wartość |
Opis |
ERROR_DETAIL_NONE |
0 |
|
ERROR_DETAIL_ERRNO |
1 |
value = errno (e.g., EIO, ETIMEDOUT) |
ERROR_DETAIL_I2C_ADDRESS |
2 |
value = 7-bit addr (0..127) |
ERROR_DETAIL_MILLIVOLTS |
3 |
value = mV |
ERROR_DETAIL_NRFX_ERROR_CODE |
4 |
value = nrfx_err_t (as a number) |
ERROR_DETAIL_PERCENT |
5 |
value = 0..100 |
ERROR_DETAIL_RAW_VALUE |
6 |
value = raw |
ERROR_DETAIL_REGISTER |
7 |
value = register address (0..65535) |