.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "eg25-manager" "5" "2024-03-10"
.P
.SH NAME
eg25-manager configuration file format
.P
.SH SYNOPSIS
eg25-manager uses toml formatted files for configuration.\&
.P
Configurations are loaded from:
.RS 4
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB/etc/eg25-manager/<compatible>.\&toml\fR: User-provided overrides (optional)
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB/usr/share/eg25-manager/<compatible>.\&toml\fR: Default configuration (required)

.RE
.P
.RE
.SH SECTION: manager
General settings for eg25-manager.\&
.P
\fBpoweron_delay\fR int (microseconds)
.RS 4
Delay between de-asserting RESET and starting the PWRKEY sequence.\&
.P
.RE
.SH SECTION: suspend
Settings for how to handle suspend on the system where eg25-manager is running.\&
.P
\fBboot_timeout\fR int (seconds)
.RS 4
Prevent the system from suspending for boot_timeout seconds to allow the
modem to fully boot.\&
.P
Default: 120 if unset or zero.\&
.P
.RE
\fBrecovery_timeout\fR int (seconds)
.RS 4
Amount of time to wait for the modem to reappear after suspend.\& If the
timeout is reached the modem'\&s USB connection will be reset.\&
.P
Default: 9 if unset or zero.\&
.P
.RE
.SH SECTION: at
AT commands to send when different events happen, and where to send them to.\&
.P
Each command has 4 possible elements:
.RS 4
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBcmd\fR: the AT command itself, which will be translated to "AT+`cmd`"
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBsubcmd\fR: the subcommand in case a single AT command can be used to
change multiple parameters, such as QCFG
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBvalue\fR: the command'\&s argument(s), usually used to set the value of a
specific parameter
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBexpect\fR: the expected return value; the command is first executed
without any value in order to query the current state.\& This state is
then compared to the \fBexpect\fR string; if they don'\&t match, the command
is then executed with value \fBexpect\fR in order to set the parameter to
the expected value
.RE

.RE
A command can have \fBexpect\fR OR \fBvalue\fR configured, but it shouldn'\&t have both
.P
\fBNOTE:\fR If a command sequence is configured in an override file, the default
commands won'\&t be loaded from the system configuration.\& The default commands
should be copied into the override file when changing them.\&
.P
\fBuart\fR string
.RS 4
The serial port to use for sending AT commands to the modem.\&
.P
.RE
\fBconfigure\fR List of commands
.RS 4
AT commands to send to the modem when it is first started.\&
.P
.RE
\fBsuspend\fR List of commands
.RS 4
AT commands to send to the modem before the system suspends.\&
.P
.RE
\fBresume\fR List of commands
.RS 4
AT commands to send to the modem after the system resumes from suspend.\&
.P
.RE
\fBreset\fR List of commands
.RS 4
AT commands to send to the modem if resetting the usb port fails.\&
.P
.RE
.SH SECTION: gnss
Settings for uploading AGPS assistance data to the modem.\&
.P
\fBenabled\fR boolean
.RS 4
Enable or disable uploading AGPS data to the modem
.P
.RE
\fBurl\fR string
.RS 4
The directory on the server that contains the assistance files
.P
Example: https://xtrapath4.\&izatcloud.\&net
.P
.RE
\fBfile\fR string
.RS 4
The name of the assistance file on the server.\&
.P
Example: xtra2.\&bin
.P
.RE
.SH SECTION: gpio
The \fBgpio\fR section defines the GPIO pins to use for different modem functions.\&
These settings should only be changed when porting eg25-manager to a new device;
for this reason they aren'\&t documented here.\&
.P
.SH EXAMPLES
Print the firmware version every time the phone wakes from suspend:
.nf
.RS 4
[at]
resume = [
    { cmd = "QGMR" },
]
.fi
.RE
.P
Disable uploading AGPS data to the modem:
.nf
.RS 4
[gnss]
enabled = false
.fi
.RE
.P
.SH SEE AlSO
\fBeg25-manager\fR(8)