ble_ots_object.h 3.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. /**
  2. * Copyright (c) 2017 - 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. /**@file
  41. *
  42. * @defgroup ble_sdk_srv_ots_obj Object Transfer Service, Object characteristics
  43. * @{
  44. * @ingroup ble_ots
  45. * @brief Object Transfer Service module
  46. *
  47. * @details This module is responsible for the object properties characteristics.
  48. */
  49. #ifndef BLE_OTS_OBJECT_H__
  50. #define BLE_OTS_OBJECT_H__
  51. #include <stdint.h>
  52. #include "ble_ots.h"
  53. /**@brief Function for initializing the Object Transfer Object representation characteristics.
  54. *
  55. * @param[out] p_ots_object_chars Object Transfer Service object characteristics representation structure. * This structure will have to be supplied by the application. It * will be initialized by this function, and will later be used to * identify this particular instance.
  56. * @param[in] p_ots_object_chars_init Information needed to initialize the module.
  57. *
  58. * @return NRF_SUCCESS on successful initialization, otherwise an error code.
  59. */
  60. uint32_t ble_ots_object_representation_init(ble_ots_object_chars_t * p_ots_object_chars,
  61. ble_ots_object_chars_init_t * p_ots_object_chars_init);
  62. /**@brief Refresh the characteristics of the current object.
  63. * @param[in] p_ots_object_chars Pointer the the object characteristics.
  64. * @return NRF_SUCCESS if everything was refreshed.
  65. */
  66. uint32_t ble_ots_object_refresh_current(ble_ots_object_chars_t * p_ots_object_chars);
  67. /**@brief Function for handling the Application's BLE Stack events.
  68. *
  69. * @details Handles all events from the BLE stack of interest to the list filter module.
  70. *
  71. * @param[in] p_ots_object_chars Pointer the the object characteristics.
  72. * @param[in] p_ble_evt Event received from the BLE stack.
  73. */
  74. void ble_ots_object_on_ble_evt(ble_ots_object_chars_t * p_ots_object_chars,
  75. ble_evt_t const * p_ble_evt);
  76. #endif // BLE_OTS_OBJECT_H__
  77. /** @} */ // End tag for the file.