HyperPulse™ library API

Functions
int32_t	hyperpulse_lib_init (void)
	Initialise the Myriota HyperPulse™ library.
bool	hyperpulse_lib_is_initialised (void)
	Return status of Myriota HyperPulse™ library initialisation.
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.
void	hyperpulse_lib_unsolicited_at_response_app_handler (const char *const response)
	APP defined notification function that library uses to send unsolicited modem response.

Detailed Description

This is the group of APIs supported by Myriota HyperPulse™ library.

Function Documentation

hyperpulse_lib_init()

int32_t hyperpulse_lib_init

(

void

)

Initialise the Myriota HyperPulse™ library.

Returns

0 on success, error code on failure.

hyperpulse_lib_is_initialised()

bool hyperpulse_lib_is_initialised

(

void

)

Return status of Myriota HyperPulse™ library initialisation.

Returns

true on successful initialisation, false on failure or fault state.

hyperpulse_lib_send_at_command()

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.

Parameters

	cmd	AT command string buffer in ASCII format.
[out]	response	Buffer to receive modem response into.
	response_len	Byte length of provided response buffer.

Returns

0 on success, error code on failure.

hyperpulse_lib_unsolicited_at_response_app_handler()

void hyperpulse_lib_unsolicited_at_response_app_handler

(

const char *const

response

)

APP defined notification function that library uses to send unsolicited modem response.

Parameters

response

Unsolicited modem response in ASCII string format.