Zephyr API Documentation 4.4.99
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Modem_cellular

Functions

int cellular_modem_pause_periodic_script (const struct device *dev)
 Pause the cellular_modem driver's periodic chat script.
int cellular_modem_resume_periodic_script (const struct device *dev)
 Resume the cellular_modem driver's periodic chat script.

Detailed Description

Function Documentation

◆ cellular_modem_pause_periodic_script()

int cellular_modem_pause_periodic_script ( const struct device * dev)

#include <zephyr/drivers/modem/modem_cellular.h>

Pause the cellular_modem driver's periodic chat script.

Scheduled periodic-script runs are suppressed until cellular_modem_resume_periodic_script() is called. An in-flight script invocation at the time of this call is allowed to complete; suppression takes effect from the next scheduled run.

Parameters
devCellular device instance backed by the cellular_modem driver
Return values
0Success
-ENOTSUPDevice has no periodic chat script configured
-EINVALPeriodic script is already paused
See also
cellular_modem_resume_periodic_script

◆ cellular_modem_resume_periodic_script()

int cellular_modem_resume_periodic_script ( const struct device * dev)

#include <zephyr/drivers/modem/modem_cellular.h>

Resume the cellular_modem driver's periodic chat script.

Re-enables the periodic script. If at least one scheduled run was skipped while paused, the script fires immediately; otherwise the periodic timer restarts at the configured interval.

Parameters
devCellular device instance backed by the cellular_modem driver
Return values
0Success
-ENOTSUPDevice has no periodic chat script configured
-EINVALPeriodic script is not currently paused
See also
cellular_modem_pause_periodic_script