Local administration v2.4

This page has been updated on the 1st April 2010.

To configure your device in local you need, first to install the software Tera Term on your computer, you can download it here.

How to access to the console

his will show you how to use Tera Term.

  1. Connect your device to your computer using the black serial port of the C4-D cable.
  2. Open TeraTerm.
  3. Select the COM port.
  4. Click OK.
  5. Open the “Setup” menu and select “Serial port”.
  6. Enter the following values:
    • Baud rate: 115200
    • Data bits: 8
    • Parity: none
    • Stop bit: 1
    • Flow control: none
  7. Type #SWITCH# in upper case then press “enter” to access the light console.

Here is what you should see :

This console is organized in three separate screens. Each screen has different commands:

  • the first screen is made for the basic commands.
  • the second screen contains the advanced commands.
  • the third screen lets you run some commands directly on the device.

To switch of screen just enter “screen 0/1/2”.

  • Screen 0

  • Screen 1

  • Screen 2

How to properly reset the device?

To reset the device you need to be in the screen 1.

  1. Enter “screen 1” to access to the advanced commands screen.
  2. Then enter “reboot” and wait until the device has finished its reboot process

How to send a configuration file to the device using Kermit?

First in the screen 0, enter the command “configure”.

Then the console is waiting to receive the file.

In Tera Term :

  1. Click on the menu ’File.
  2. Click on ‘Transfer’.
  3. Select ‘Kermit’.
  4. Select ‘Send…’.

Then choose the configuration file you want to send to the device, this file must be named “config.txt”.

How to set/check a parameter through the console?

Set a parameter

Use the following command to set a parameter :
s component parameter index value

Example :

  1. Open the screen 0.
  2. Type s dataRecorder fieldPeriod 8 60 and press “enter”.

Check a parameter

Use the following command to check a parameter through the light console:
g component parameter index

Example :

  1. Open the screen 0.
  2. Type g dataRecorder fieldPeriod 8 and press “enter”.

The other command of the screen 0

The 1wire command

This command is used to display the list of detected 1wire devices as temperature sensors or driver key.

  • Type 1wire then press “enter”.

The iostate command

This command is used to display the state of inputs and outputs.

  • Type iostate then press < ENTER>.

The modem command

This command is used to display the modem information as the IMEI, the APN, etc.

  • Type modem then press < ENTER>.

The gpspos command

This command is used to display the GPS information as antenna configuration, current position, etc.

  • Type gpspos then press “enter”.

The list command

This command is used to list the parameters.

  • Type list then press “enter” to display the list of all components parameters.
  • Type list then press “enter” to display the list of all parameters.
  • Type list all dl then press “enter” to download the list of all parameters in a config.txt file.

The log command

This command is used to display the software debug.

  • Type log then press “enter” to display the value of selected parameter.

The logdump command

This command is used to display the software debug since the device started (current session). For instance, this is useful to check if a component has correctly been started.

  • Type logdump then press “enter” to display the log.

The commands of the screen 1

The ip command

This command is used to display the current ip.

  • Type ip then press “enter” to display the ip (host and connected device).

The stats command

This command displays the following data:

  • The software status;
  • The GPRS update status;
  • The restore status;
  • The content of the public DSA key;
  • The PPP status;
  • The RTC time;
  • Information about the memory.
  • Type stats then press “enter” to display the statistics.

    The llog command

    This command allows you to retrieve the following logs:

    • Software
    • Gps (not implemented yet)
    • Update
    • Kernel
    • Modem AT (not implemented yet)
    • modem PPP (not implemented yet)
  • Type llog {option} then press “enter” to display the logs.

    The logs command

    This command lets you download/delete stored logs:

    • Type logs {option} then press “enter” to display the logs.

    The usercpn command

    This command is for listing, starting, stopping or removing a user module.

    • Type usercpn {option} {module} then press “enter”.

    The gprsupdate command

    This command is used to launch a GPRS update (over the air) from the device.

    • Type gprsupdate start then press “enter”.
    • Fill in required fields (login, host, port, path) then press “enter” to launch the update.

    Once you launched a gprs update, you can display the log using the command llog.

    • Type llog update then press “enter” to display the logs.

    The update command

    This command is used to install a package.

    • Type update then press .
    • Type (or copy) the full name (including the extension) of the file then press .

    Note: You can update only the following types of packages:

    • PKG-usersd-*.tar.gz
    • PKG-user-*.tar.gz
    • PKG-Deployment-patch.tar.gz

    The name is case sensitive.

    The restore command

    This command is used to restore the parameters of the device.

    • Type restore all then press “enter” to restore the write partition, the pdm and the DB.
    • Type restore write then press “enter” to restore the write partition.
    • Type restore pdm then press “enter” to restore the pdm.
    • Type restore db then press “enter” to restore the db.

    The restoreFull command

    This command is used to restore (software) the device.

    • Type restoreFull then press “enter”.

    The version command

    This command is for retrieving all the device hardware/software versions.

    • Type version then press “enter”.

    The commands of the screen2

    This screen lets you using the APIs.

    Note: This console is not fully implemented in the current console release.