IPC@CHIP® RTOS-PPC – API Documentation

Header image

Main page


CHIP.INI [PPPSERVER]


[PPPSERVER]
ENABLE=0/1

Disable/enable PPP server task.
Default:
By default, PPP server is disabled.
Example:
 [PPPSERVER]
 ENABLE=1
Since:
SC2x3 V1.00


[PPPSERVER]
PRIO=prio

Defines the task priority of the PPP server task (PPPS). Allowed value are 2-127.
Default:
Default is 16.
Example:
 [PPPSERVER]
 PRIO=8
Since:
SC2x3 V1.00


[PPPSERVER]
IPv6_USE=0/1

Enable the usage of IPv6 protocol at the PPP server and disable IPv4.
Default:
By default IPv6 is disabled, the PPP server runs with IPv4.
Example:
 [PPPSERVER]
 IPv6_USE=1
Since:
SC2x3 V1.00


[PPPSERVER]
MODEMTRACE=0/1

Disable/enable the trace of the control communication between IPC@CHIP® and a connected modem. The modem strings (AT commands and answers) defined in CHIP.INI will be printed on STDOUT, if MODEM_TRACE=1. This can be useful for testing the modem configuration and debugging the PPP dial procedures.

If a command should be send from IPC@CHIP® to the modem, the MODEMTRACE output indicates only, that the command was successful placed at the send queue of the serial port. It doesn't indicate, that the command was physically send on the wire (e.g. if hardware flow control blocks the send queue).
Received characters with an ASCII value smaller than 0x20 are printed as numbers.
Default:
By default, tracing is disabled.
Example:
 [PPPSERVER]
 MODEMTRACE=1
Since:
SC2x3 V1.00


[PPPSERVER]
COMPORT=serial UART device for the PPP server

Define your serial device for the PPP server. Valid devices are UART1, UART2, UART3, UART4, UART5 or UART6.
Default:
No default.
Example:
 [PPPSERVER]
 COMPORT=UART3
Since:
SC2x3 V1.00


[PPPSERVER]
ADDRESS=IP address of the PPP server

Defines the IP address for the PPP server. Only numerical IP addresses are allowed here.
Default:
If no address entry was found, the address will be set to 1.1.2.1.
Example:
 [PPPSERVER]
 ADDRESS=192.168.205.1
Since:
SC2x3 V1.00


[PPPSERVER]
REMOTEADDRESS=IP address for the remote PPP client

Defines the IP address for the remote PPP client. Only numerical IP addresses are allowed here.
Default:
If no address entry was found, the address will be set to 1.1.2.2.
Example:
 [PPPSERVER]
 REMOTEADDRESS=192.168.205.2
Since:
SC2x3 V1.00


[PPPSERVER]
NETMASK=IP address subnet mask for the PPP server

Defines the IP address subnet mask of the PPP server.
Default:
If no subnet mask entry was found, the subnet mask will be set to 255.255.255.0.
Example:
 [PPPSERVER]
 NETMASK=255.255.255.0
Since:
SC2x3 V1.00


[PPPSERVER]
GATEWAY=IP address of gateway

Defines the IP address of the gateway if PPP Connection is established.

If no gateway entry was found, the gateway will be untouched. The TCP/IP stack of the IPC@CHIP® supports only one valid default gateway for all device interfaces: Ethernet, PPP Interface, etc.

If you define a gateway in the PPPSERVER section of the CHIP.INI, it becomes the default gateway for all interfaces when a PPP link to the server is established. The default gateway must be the same IP Address as the remote peer. It does not make sense to define a different IP, because the remote Peer is the only peer, which is reachable. If a different IP than the remote IP is defined, the remote IP will used for the gateway entry automatically. During a PPP server connection the command ipcfg indicates this default gateway. After the PPP session, the old gateway (if any was defined) will be restored.

The @CHIP-RTOS-PPC provides some functions for modifying the default gateway: see SetDefaultGateway(), RemoveDefaultGateway(), DefaultGateway()
Default:
No default.
Example:
 [PPPSERVER]
 GATEWAY=192.168.205.2
Since:
SC2x3 V1.00


[PPPSERVER]
AUTH=0/1/2

Set PPP authentication mode for the remote PPP client
     0: No authentication
     1: PAP authentication
     2: CHAP authentication
The following example selects PAP authentication mode.

If AUTH!=0 you must define two user name / password pairs used to authenticate the PPP client. The client must use one of these pairs to get connected to the IPC@CHIP® PPP server.
Default:
By default, authentication is disabled.
Example:
 [PPPSERVER]
 AUTH=1
Since:
SC2x3 V1.00


[PPPSERVER]
MTU=Bytes

Sets the Maximum Transfer Unit of the PPP server interface. By default, PPP server MTU is 1024. Min. value is 68.
Example:
 [PPPSERVER]
 MTU=1300
Since:
SC2x3 V1.00


[PPPSERVER]
IDLETIME=seconds

Sets the idle time, after which the PPP server closes the connection. A value of 0 means no idle timeout.
Default:
By default, PPP server idle time is 120 seconds.
Example:
 [PPPSERVER]
 IDLETIME=500
Since:
SC2x3 V1.00


[PPPSERVER]
FLOWCTRL=0/1/2

Set flow control mode of the PPP server's serial device:
     0: none
     1: XON/XOFF
     2: RTS/CTS
Default:
By default, FLOWCTRL=2 (RTS/CTS)
Example:
 [PPPSERVER]
 FLOWCTRL=1
Since:
SC2x3 V1.00


[PPPSERVER]
MODEM=0/1

Disable (0) / Enable (1) usage of a modem.
Default:
By default, the usage of a modem is disabled.
Example:
 [PPPSERVER]
 MODEM=1
Since:
SC2x3 V1.00


[PPPSERVER]
USERx=user name

Define the user name for PPP server, using PAP or CHAP authentication.

You can define a USER0 and a USER1. You must specify both the user name and password.

Both user name and password are case sensitive.

The entries are only valid if AUTH != 0 is specified. Maximum name size: 49 characters.

Important notice: To avoid security leaks you must define both user names and passwords.
Default:
Default user name is 'ppps', default password is 'ppps' for both USER0 and USER1.
Example:
 [PPPSERVER]
 USER0=otto
Since:
SC2x3 V1.00


[PPPSERVER]
PASSWORDx=password

Define the password for a PPP server user, using PAP or CHAP authentication.

You can define a PASSWORD0 for USER0 and a PASSWORD1 for USER1.

Both user name and password are case sensitive.

The entries are only valid if AUTH != 0 is specified. Maximum password size: 49 characters.
Default:
Default user is 'ppps', default password is 'ppps'.
Example:
 [PPPSERVER]
 USER0=oto
 PASSWORD0=ottopass
Since:
SC2x3 V1.00


[PPPSERVER]
BAUD=baud rate

Sets the BAUD rate of the PPP server serial port.
Default:
By default, PPP server BAUD rate is 38400 (with 8 data bits, no parity, 1 stop bit).
Example:
 [PPPSERVER]
 BAUD=19200
Since:
SC2x3 V1.00


[PPPSERVER]
INITCMDx=modem command string

Defines modem commands to initialize your modem connected to the IPC@CHIP® at the start of the IPC@CHIP® PPP server and after a modem hang-up following a PPP session.

You can define a maximum of 5 modem commands e.g. INITCMD0=ATZ.
The entries are only valid if MODEM=1 is specified.
The maximum length for each command string is 80 characters.
Default:
No default.
Example:
 [PPPSERVER]
 INITCMD0=ATZ
Since:
SC2x3 V1.00


[PPPSERVER]
INITANSWERx=modem answer string of init command x

Defines the expected modem answer x for the initialize command x.

You can define a maximum of 5 modem answers e.g. INITANSWER0=OK.
The entries are only valid, if MODEM=1 is specified.
The maximum length for each answer string is 80 characters.
Default:
Default for all answer strings: OK
Example:
 [PPPSERVER]
 INITANSWER0=OK
Since:
SC2x3 V1.00


[PPPSERVER]
INITTIMEOUTx=timeout in seconds for wait an the modem's answer

Define the timeout value in seconds for waiting on an answer from the modem. A value of 0 means wait forever for the modem answer.
The entries are only valid if MODEM=1 is specified.
Default:
Default value: 2 seconds
Example:
 [PPPSERVER]
 INITTIMEOUT0=3
Since:
SC2x3 V1.00


[PPPSERVER]
INITRETRIESx=retries, if the modem init answer failed

Define the number of retries used when the modem initial answer fails.
This entry is only valid if MODEM=1 is specified.
Default:
Default value: 1
Example:
 [PPPSERVER]
 INITRETRIES0=2
Since:
SC2x3 V1.00


[PPPSERVER]
MODEMCTRL=0/1/2/3

Allow modem online control ("carrier loss detection") by the PPP server for closing an opened session.
MODEMCTRL = 0: Disabled.
MODEMCTRL = 1: Executing a predefined set of modem commands/answers (see CTRLCMDx) to detect a "carrier loss" situation. The commands are executed after each time interval during which the PPP server receive no data.
MODEMCTRL = 2: Same as MODEMCTRL = 1, but the commands are always executed after the time interval, regardless whether or not the PPP server has received any data.
MODEMCTRL = 3: Detect a "carrier loss" situation by cyclic check of the DCD signal inside of the RTOS PPP server task. This mode is recommended.

Look here for more details.
Default:
MODEMCTRL = 0 (Disabled)
Example:
 [PPPSERVER]
 MODEMCTRL=3
Since:
SC2x3 V1.00


[PPPSERVER]
CTRLTIME=seconds

Sets the idle interval time, at which the PPP server executes the configured control commands (see CTRLCMDx).

If the PPP server doesn't receive regular PPP data during this interval, it executes the control commands. If execution of one of the control commands fails, the PPP server then closes the connection.

The CTRLTIME must be a smaller value than the IDLETIME of the PPP server.
Default:
By default, PPP server idle control time is 60 seconds.
Example:
 [PPPSERVER]
 CTRLTIME=120
Since:
SC2x3 V1.00


[PPPSERVER]
CTRLCMDx=modem online ("carrier") control command string

Defines modem command to control if modem is online or not.

You can define a maximum of 5 modem commands e.g. CTRLCMD0=+++.
The maximum length for each control command string is 80 characters.
The entries are only valid, if MODEMCTRL=1 is specified.
Default:
CTRLCMD0=+++
CTRLCMD1=ATO
Example:
 [PPPSERVER]
 CTRLCMD0=+++
Since:
SC2x3 V1.00


[PPPSERVER]
CTRLANSWERx=modems answer of ctrl command x

Defines the expected modem answer x for the online control command x.

You can define a maximum of 5 modem answers e.g. CTRLANSWER0=OK.
The maximum length for each answer string is 80 characters.
The entries are only valid, if MODEMCTRL=1 is specified.
Default:
CTRLANSWER0=OK
CTRLANSWER2=OK
Example:
 [PPPSERVER]
 CTRLANSWER0=OK
Since:
SC2x3 V1.00


[PPPSERVER]
CTRLTIMEOUTx=timeout in seconds for wait on the modem's answer

Defines the timeout value in seconds for waiting on an answer from the modem. A value of 0 means wait forever for the modem answer.
The entries are only valid if MODEMCTRL=1 is specified.
Default:
CTRLTIMEOUT0=2
CTRLTIMEOUT1=0
CTRLTIMEOUT2=2
Example:
 [PPPSERVER]
 CTRLTIMEOUT0=3
Since:
SC2x3 V1.00


[PPPSERVER]
CTRLRETRIESx=retries, if the modem online control answer failed

Defines the number of retries used when the modem control answer fails.

This entry is only valid if MODEMCTRL=1 is specified.
Default:
Default value: 1
Example:
 [PPPSERVER]
 CTRLRETRIES0=2
Since:
SC2x3 V1.00


[PPPSERVER]
CMDMODE=string for switch to modem command mode

Defines the string which switches the modem into the command mode.

The entries are only valid if MODEM=1 is specified.
Default:
Default string for CMDMODE=+++
Example:
 [PPPSERVER]
 CMDMODE=+++
Since:
SC2x3 V1.00


[PPPSERVER]
HANGUPDELAY=seconds

Defines the time in seconds for switching modem into command mode for hang-up commands.
The entries are only valid if MODEM=1 is specified.
Default:
Default time: 2 seconds
Example:
 [PPPSERVER]
 HANGUPDELAY=4
Since:
SC2x3 V1.00


[PPPSERVER]
HANGUPCMDx=modem command string

Defines modem commands to hang-up the modem connected to the IPC@CHIP®.

You can define a maximum of 5 modem hang-up commands e.g. HANGUPCMD0=ATH, which will be executed if the PPP connection is closed.
The maximum length for each command string is 80 characters.
Default:
HANGUPCMD0=ATH0
Example:
 [PPPSERVER]
 HANGUPCMD0=ATH
Since:
SC2x3 V1.00


[PPPSERVER]
HANGUPANSWERx=modems answer for hang-up command x

Defines the expected modem answer x for the hang-up command x.

You can define a maximum of 5 modem answers e.g. HANGUPANSWER0=OK.
The maximum length for each answer message is 80 characters.
Default:
Default for all answer strings: OK
Example:
 [PPPSERVER]
 HANGUPANSWER0=OK
Since:
SC2x3 V1.00


[PPPSERVER]
HANGUPTIMEOUTx=timeout in seconds for wait on answer from modem

Defines the timeout value in seconds used when waiting on the modem's answer. A value of 0 means wait forever.
Default:
Default value: 2 seconds
Example:
 [PPPSERVER]
 HANGUPTIMEOUT0=3
Since:
SC2x3 V1.00


[PPPSERVER]
HANGUPRETRIESx=retries, if the modem hang-up answer failed

Defines the number of retries used if the modem hang-up answer fails.
Default:
Default value: 1
Example:
 [PPPSERVER]
 HANGUPRETRIES0=2
Since:
SC2x3 V1.00


[PPPSERVER]
CONNECTMSGx=modem message string

Defines the expected modem message to get connected to a peer modem.

You can define a maximum of three modem messages e.g. CONNECTMSG0=RING.
The maximum length for each connect message is 80 characters.
Default:
CONNECTMSG0=RING
CONNECTMSG1=CONNECT
Example:
 [PPPSERVER]
 CONNECTMSG0=RING
Since:
SC2x3 V1.00


[PPPSERVER]
CONNECTANSWERx=modem command for incoming connect message x

Defines the expected modem answer x for the incoming connect message x.

You can define a maximum of three modem answers e.g. CONNECTANSWER0=ATA.
The maximum length for each answer string is 80 characters.
Default:
CONNECTANSWER0=ATA
Example:
 [PPPSERVER]
 CONNECTANSWER0=ATA
Since:
SC2x3 V1.00


[PPPSERVER]
CONNECTTIMEOUTx=timeout seconds for wait on the modem's connect message x

Defines the timeout value in seconds used when waiting on the modem connect message. A value of 0 means wait forever.
Default:
CONNECTTIMEOUT0=0
CONNECTTIMEOUT1=60
Example:
 [PPPSERVER]
 CONNECTTIMEOUT0=0
Since:
SC2x3 V1.00





Top of page | Main page

Copyright © 2017 Beck IPC GmbH
Generated on Thu Jan 26 16:21:35 2017 by Doxygen 1.6.1