ble_ots_oacp.h 3.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091
  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_oacp Object Transfer Service, OACP handling
  43. * @{
  44. * @ingroup ble_ots
  45. * @brief Object Transfer Service module
  46. *
  47. * @details This module is responsible for handling the Object Transfer Service
  48. * Object Action Control Point.
  49. */
  50. #ifndef BLE_OTS_OACP_H__
  51. #define BLE_OTS_OACP_H__
  52. #include <stdint.h>
  53. #include "ble_ots.h"
  54. #include "nrf_ble_gq.h"
  55. /**@brief Function for initializing the Object Transfer OACP characteristic.
  56. *
  57. * @param[out] p_ots_oacp Object Transfer Service OACP structure. This structure will have
  58. * to be supplied by the application. It will be initialized by this function,
  59. * and will later be used to identify this particular instance.
  60. * @param[in] p_ots_oacp_init Information needed to initialize the module.
  61. *
  62. * @return NRF_SUCCESS on successful initialization, otherwise an error code.
  63. */
  64. uint32_t ble_ots_oacp_init(ble_ots_oacp_t * p_ots_oacp, ble_ots_oacp_init_t * p_ots_oacp_init);
  65. /**@brief Function for handling the Application's BLE Stack events.
  66. *
  67. * @details Handles all events from the BLE stack of interest to the OACP module.
  68. *
  69. * @param[in] p_ots_oacp Object Transfer Service OACP structure
  70. * @param[in] p_ble_evt Event received from the BLE stack.
  71. */
  72. void ble_ots_oacp_on_ble_evt(ble_ots_oacp_t * p_ots_oacp, ble_evt_t const * p_ble_evt);
  73. /**@brief Execute an Object Action Control Point procedure
  74. *
  75. * @param[in] p_ots_oacp Object Transfer Service OACP structure.
  76. * @param[in] p_oacp_proc Pointer to the procedure to be applied.
  77. *
  78. * @return BLE_OTS_WRITE_SUCCESS on success, otherwise an error.
  79. */
  80. ble_ots_oacp_res_code_t ble_ots_oacp_do_proc(ble_ots_oacp_t * p_ots_oacp,
  81. ble_ots_oacp_proc_t * p_oacp_proc);
  82. #endif // BLE_OTS_OACP_H__
  83. /** @} */ // End tag for the file.