Myriota HyperPulse™ Library 1.0
Loading...
Searching...
No Matches
hyperpulse_lib.h
1/****************************************************************
2 * Copyright (c) 2025, Myriota Pty Ltd, All Rights Reserved
3 * @file hyperpulse_lib.h
4 * @brief Myriota HyperPulse™ Library API
5 *
6 * SPDX-License-Identifier: BSD-3-Clause-Attribution
7 *
8 * This file is licensed under the BSD with attribution (the "License"); you
9 * may not use these files except in compliance with the License.
10 *
11 * You may obtain a copy of the License here:
12 * LICENSE-BSD-3-Clause-Attribution.txt and at
13 * https://spdx.org/licenses/BSD-3-Clause-Attribution.html
14 *
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 *****************************************************************/
18#ifndef HYPERPULSE_LIB_H
19#define HYPERPULSE_LIB_H
20
21/********************************************
22 * Includes
23 *********************************************/
24
25#include <stdbool.h>
26#include <stddef.h>
27#include <stdint.h>
28
29#ifdef __cplusplus
30extern "C" {
31#endif
32
33/********************************************
34 * Library APIs
35 *********************************************/
36
47int32_t hyperpulse_lib_init(void);
48
54
65 const char *const cmd, char *const response, size_t response_len);
66
74
75 // end of hyperpulse_lib_api_group
76
77#ifdef __cplusplus
78}
79#endif
80
81#endif // HYPERPULSE_LIB_H
int32_t hyperpulse_lib_init(void)
Initialise the Myriota HyperPulse™ library.
void hyperpulse_lib_unsolicited_at_response_app_handler(const char *const response)
APP defined notification function that library uses to send unsolicited modem response.
int32_t hyperpulse_lib_send_at_command(const char *const cmd, char *const response, size_t response_len)
Send AT command in ASCII format to the modem and receive ASCII response in buffer of specified length...
bool hyperpulse_lib_is_initialised(void)
Return status of Myriota HyperPulse™ library initialisation.