ancs_attr_parser.h 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. /**
  2. * Copyright (c) 2012 - 2020, Nordic Semiconductor ASA
  3. *
  4. * All rights reserved.
  5. *
  6. * Redistribution and use in source and binary forms, with or without modification,
  7. * are permitted provided that the following conditions are met:
  8. *
  9. * 1. Redistributions of source code must retain the above copyright notice, this
  10. * list of conditions and the following disclaimer.
  11. *
  12. * 2. Redistributions in binary form, except as embedded into a Nordic
  13. * Semiconductor ASA integrated circuit in a product or a software update for
  14. * such product, must reproduce the above copyright notice, this list of
  15. * conditions and the following disclaimer in the documentation and/or other
  16. * materials provided with the distribution.
  17. *
  18. * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
  19. * contributors may be used to endorse or promote products derived from this
  20. * software without specific prior written permission.
  21. *
  22. * 4. This software, with or without modification, must only be used with a
  23. * Nordic Semiconductor ASA integrated circuit.
  24. *
  25. * 5. Any software provided in binary form under this license must not be reverse
  26. * engineered, decompiled, modified and/or disassembled.
  27. *
  28. * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
  29. * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  30. * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
  31. * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
  32. * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33. * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
  34. * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  35. * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  36. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  37. * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  38. *
  39. */
  40. #ifndef BLE_ANCS_ATTR_PARSER_H__
  41. #define BLE_ANCS_ATTR_PARSER_H__
  42. #include "nrf_ble_ancs_c.h"
  43. /** @file
  44. *
  45. * @addtogroup ble_ancs_c
  46. * @{
  47. */
  48. /**@brief Function for parsing notification or app attribute response data.
  49. *
  50. * @details The data that comes from the Notification Provider can be much longer than what
  51. * would fit in a single GATTC notification. Therefore, this function relies on a
  52. * state-oriented switch case.
  53. * UID and command ID will be received only once at the beginning of the first
  54. * GATTC notification of a new attribute request for a given iOS notification.
  55. * After this, we can loop several ATTR_ID > LENGTH > DATA > ATTR_ID > LENGTH > DATA until
  56. * we have received all attributes we wanted as a Notification Consumer.
  57. * The Notification Provider can also simply stop sending attributes.
  58. *
  59. * 1 byte | 4 bytes |1 byte |2 bytes |... X bytes ... |1 bytes| 2 bytes| ... X bytes ...
  60. * --------|-------------|-------|--------|----------------|-------|--------|----------------
  61. * CMD_ID | NOTIF_UID |ATTR_ID| LENGTH | DATA |ATTR_ID| LENGTH | DATA
  62. *
  63. * @param[in] p_ancs Pointer to an ANCS instance to which the event belongs.
  64. * @param[in] p_data_src Pointer to data that was received from the Notification Provider.
  65. * @param[in] hvx_data_len Length of the data that was received from the Notification Provider.
  66. */
  67. void ancs_parse_get_attrs_response(ble_ancs_c_t * p_ancs,
  68. const uint8_t * p_data_src,
  69. const uint16_t hvx_data_len);
  70. /** @} */
  71. #endif // BLE_ANCS_ATTR_PARSER_H__