Specifications

HYLAFAX-CONFIG(5F) HYLAFAX-CONFIG(5F)
corresponds to the n’th instance that this CallIDPattern is from the top in the modem configura-
tion file. Forexample, for the ZyXEL U-1496 this parameter would be set to
CallIDPattern: ‘‘CALLER NAME: ’’ (note the trailing space).
If more than one message matches between instances of "RING" messages, then the message
remainders are concatenated.
The special CallID value of "SHIELDED_DTMF" is used in conjunction with ModemRingRe-
sponse and CallIDAnswerLength. After executing ModemRingResponse, HylaFAX will expect
DTMF data (usually DLE-shielded) for CallIDn until CallIDAnswerLength is reached. Note
that if the modem is in voice mode to hear these DTMF digits, then it must be returned to fax
mode in the ModemAnswerCmd. In order to prevent this feature from losing incoming fax calls,
if fax sender CNG is detected while waiting for DTMF or if ten seconds elapse without sufficient
DTMF then the remaining expected digits will be populated by whitespace, triggering fax answer-
ing.
Forexample, the following settings will cause HylaFAX to enter voice mode and go off-hook
when a RING is detected. It will then expect four DTMF digits (presumably for routing), and then
it will pause for 100 ms before returning to fax mode and answering the call.
ModemRingResponse: AT+FCLASS=8;H1
CallIDPattern: SHIELDED_DTMF
CallIDAnswerLength: 4
ModemAnswerCmd: <delay:100>AT+FCLASS=1;A
Formodems that do not support AT+FCLASS=8 (such as some USR modems) this may be an
appropriate equivalent:
ModemRingResponse: "AT#CLS=8\nAT#VLS=4\nATA"
CallIDPattern: SHIELDED_DTMF
CallIDAnswerLength: 4
ModemAnswerCmd: "<delay:100>AT+FCLASS=1\nATA"
Multiple entries of CallIDPattern are used together in one modem configuration file in order to
capture multiple CallID responses. For example, the following settings would capture "NDID"
responses from the modem as CallID1, "NMBR" responses from the modem as CallID2, "NAME"
responses as CallID3, and it would trigger ModemAnswerCmd wheneverCallID1 or CallID2
were longer than 7 or 10 characters, respectively.
CallIDPattern: "NDID="
CallIDAnswerLength: 7
CallIDPattern: "NMBR="
CallIDAnswerLength: 10
CallIDPattern: "NAME="
Note that this example is only givenasanexample, and probably would cause unexpected results.
Because pattern-matching ends when ModemAnswerCmd is sent to the modem, if "NDID",
"NMBR", and "NAME" responses came from the modem in that order,and the "NDID" response
wasatleast 7 characters long, then ModemAnswerCmd would be sent to the modem immedi-
ately following the "NDID" response, and the "NMBR" and "NAME" responses would be ignored.
Generally only one CallIDAnswerLength item should be in a modem configuration file.
CallIDAnswerLength
An integer indicating the minimum number of characters in a CallID matching the previous Cal-
lIDPattern to be receivedwhen ModemAnswerCmd is sent to the modem irrespective ofany
RingsBeforeAnswer value greater than zero. This allows the answering of calls which deliver
$Date$ 9