user_pipe.h File Reference

#include <zephyr/modem/chat.h>

Go to the source code of this file.

Functions
void	modem_at_user_pipe_init (struct modem_chat *chat)
	Initialise the AT command user pipe.
int	modem_at_user_pipe_claim (void)
	Claim the AT command user pipe to run commands.
void	modem_at_user_pipe_release (void)
	Release the AT command user pipe to other users.

Function Documentation

modem_at_user_pipe_claim()

int modem_at_user_pipe_claim

(

void

)

Claim the AT command user pipe to run commands.

Return values

0	On success
-EPERM	Modem is not ready
-EBUSY	User pipe already claimed

modem_at_user_pipe_init()

void modem_at_user_pipe_init

(

struct modem_chat *

chat

)

Initialise the AT command user pipe.

Parameters

chat	Chat instance that will be used with the user pipe

modem_at_user_pipe_release()

void modem_at_user_pipe_release

(

void

)

Release the AT command user pipe to other users.

Must be called after modem_at_user_pipe_claim when pipe is no longer in use.