aboutsummaryrefslogtreecommitdiff
path: root/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/bsp/bsp_cli.h
diff options
context:
space:
mode:
Diffstat (limited to 'thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/bsp/bsp_cli.h')
-rw-r--r--thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/bsp/bsp_cli.h83
1 files changed, 83 insertions, 0 deletions
diff --git a/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/bsp/bsp_cli.h b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/bsp/bsp_cli.h
new file mode 100644
index 0000000..8c71d6a
--- /dev/null
+++ b/thirdparty/nRF5_SDK_15.0.0_a53641a/components/libraries/bsp/bsp_cli.h
@@ -0,0 +1,83 @@
+/**
+ * Copyright (c) 2017 - 2018, Nordic Semiconductor ASA
+ *
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without modification,
+ * are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form, except as embedded into a Nordic
+ * Semiconductor ASA integrated circuit in a product or a software update for
+ * such product, must reproduce the above copyright notice, this list of
+ * conditions and the following disclaimer in the documentation and/or other
+ * materials provided with the distribution.
+ *
+ * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
+ * contributors may be used to endorse or promote products derived from this
+ * software without specific prior written permission.
+ *
+ * 4. This software, with or without modification, must only be used with a
+ * Nordic Semiconductor ASA integrated circuit.
+ *
+ * 5. Any software provided in binary form under this license must not be reverse
+ * engineered, decompiled, modified and/or disassembled.
+ *
+ * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
+ * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
+ * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+ * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+ * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+ * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+ * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+ * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ */
+/**@file
+ *
+ * @defgroup bsp_cli BSP over CLI Module
+ * @{
+ * @ingroup bsp
+ *
+ * @brief Module for sending BSP events over CLI.
+ *
+ * @details The module uses Command Line Interface and enables user to send events
+ * to BSP. They are later handled by the event handler provided.
+ * Available commands:
+ * - bsp btn X (where X is button number) - sends BSP_EVENT_KEY_X
+ * - bsp evt X (where X is event number) - sends BSP event with X id
+ */
+
+#ifndef BSP_CLI_H__
+#define BSP_CLI_H__
+
+#include <stdint.h>
+#include "nrf_cli.h"
+#include "bsp.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/**@brief Function for initializing the BSP over CLI Module.
+ *
+ * Before calling this function, the BSP module must be initialized.
+ *
+ * @param[in] callback Function to be called when event is recevied.
+ *
+ * @retval NRF_SUCCESS If initialization was successful.
+ */
+
+ret_code_t bsp_cli_init(bsp_event_callback_t callback);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* BSP_CLI_H__ */
+
+/** @} */