nvs.rst 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  1. .. include:: ../../components/nvs_flash/README.rst
  2. API Reference
  3. -------------
  4. Enumerations
  5. ^^^^^^^^^^^^
  6. .. doxygenenum:: nvs_open_mode
  7. Functions
  8. ^^^^^^^^^
  9. .. doxygenfunction:: nvs_flash_init
  10. .. doxygenfunction:: nvs_flash_init_custom
  11. .. doxygenfunction:: nvs_open
  12. *Note: the following nvs_set_X function are "the same" except the data type accepted*
  13. .. doxygenfunction:: nvs_set_i8
  14. .. doxygenfunction:: nvs_set_u8
  15. .. doxygenfunction:: nvs_set_i16
  16. .. doxygenfunction:: nvs_set_u16
  17. .. doxygenfunction:: nvs_set_i32
  18. .. doxygenfunction:: nvs_set_u32
  19. .. doxygenfunction:: nvs_set_i64
  20. .. doxygenfunction:: nvs_set_u64
  21. .. doxygenfunction:: nvs_set_str
  22. .. doxygenfunction:: nvs_set_blob
  23. *Note: the following nvs_get_X functions are "the same" except the data type returned*
  24. .. doxygenfunction:: nvs_get_i8
  25. .. doxygenfunction:: nvs_get_u8
  26. .. doxygenfunction:: nvs_get_i16
  27. .. doxygenfunction:: nvs_get_u16
  28. .. doxygenfunction:: nvs_get_i32
  29. .. doxygenfunction:: nvs_get_u32
  30. .. doxygenfunction:: nvs_get_i64
  31. .. doxygenfunction:: nvs_get_u64
  32. .. doxygenfunction:: nvs_get_str
  33. .. doxygenfunction:: nvs_get_blob
  34. .. doxygenfunction:: nvs_erase_key
  35. .. doxygenfunction:: nvs_erase_all
  36. .. doxygenfunction:: nvs_commit
  37. .. doxygenfunction:: nvs_close
  38. Error codes
  39. ^^^^^^^^^^^
  40. .. doxygendefine:: ESP_ERR_NVS_BASE
  41. .. doxygendefine:: ESP_ERR_NVS_NOT_INITIALIZED
  42. .. doxygendefine:: ESP_ERR_NVS_NOT_FOUND
  43. .. doxygendefine:: ESP_ERR_NVS_TYPE_MISMATCH
  44. .. doxygendefine:: ESP_ERR_NVS_READ_ONLY
  45. .. doxygendefine:: ESP_ERR_NVS_NOT_ENOUGH_SPACE
  46. .. doxygendefine:: ESP_ERR_NVS_INVALID_NAME
  47. .. doxygendefine:: ESP_ERR_NVS_INVALID_HANDLE
  48. .. doxygendefine:: ESP_ERR_NVS_REMOVE_FAILED
  49. .. doxygendefine:: ESP_ERR_NVS_KEY_TOO_LONG
  50. .. doxygendefine:: ESP_ERR_NVS_PAGE_FULL
  51. .. doxygendefine:: ESP_ERR_NVS_INVALID_STATE
  52. .. doxygendefine:: ESP_ERR_NVS_INVALID_LENGTH