• Table of contents
• Getting Started
  • Required Hardware
  • Major steps required for setup
    • Installing latest gateware and firmware into the icE1usb
    • building + installing the laforge/e1oip branch of osmo-e1d
      • dependencies
      • building
      • installation (optional)
    • requesting connection
    • creating a config file
  • Checking status
    • GPS lock status

Getting Started¶

This page is a work-in-progress documenting what you need to do to get connected to the Community_TDMSS7_Network using an icE1usb.

Required Hardware¶

• icE1usb hardware (contact sales@sysmocom.de for an OCTOI community special price of EUR 75)
• GPS antenna with SMA male plug (not included)
• Some equipment with an E1 interface which you want to connect to the community network. Typically this is a PBX with E1/PRI/S2M upstream connection.
• Some computer running Linux with a USB host controller to connect the icE1usb to. Note: Many USB XHCI host controllers suffer from bugs, restricting operation to only one of the two E1 ports, see Isochronous_USB_Issues for details. If you have a system with UHCI/OHCI/EHCI, use that.

Major steps required for setup¶

1. Installing latest gateware and firmware into the icE1usb
2. building + installing the laforge/e1oip branch of osmo-e1d
3. requesting a connection with the OCTOI hub
4. creating a config file for osmo-e1d
5. possibly adding a port forward in your router

Installing latest gateware and firmware into the icE1usb¶

Please follow the instructions of the icE1usb user manaul

Firmware is available from https://downloads.osmocom.org/binaries/icE1usb/firmware/all/

You will need dfu-util for performing the USB device firmware upgrade. Most distributions should have a package for this.

building + installing the laforge/e1oip branch of osmo-e1d¶

As the protocol is still under fluctuation, it is not yet part of the master branch and hence not available as a binary package yet. You will need to build osmo-e1d frm source.

dependencies¶

You will need

• build-essential (gcc, binutils, make, ...)
• autotools (autoconf, automake)
• libtool
• pkg-config
• talloc
• libosmocore
• libusb-1.0

If using distribution packages, make sure you install the development packages (e.g. libtalloc-dev).

building¶

autoreconf -fi
./configure
make

installation (optional)¶

you can run osmo-e1d from the build directory, there's no strict need to install it.

If you do install it using the below instructions, the binary will be in /usr/local/bin or whatever is configured at configure time.

make install

requesting connection¶

Please contact laforge with your IP address and port number. Right now the protocol does not yet support dynamic IP addresses.

creating a config file¶

A minimal configuration file osmo-e1d.cfg looks like shown below. osmo-e1d looks for the config file in the current working directory from where you start the program, or you can specify it with -c e.g. osmo-e1d -c /path/to/my/osmo-e1d.cfg.

e1d
 interface 0 icE1usb
  usb-serial SERIAL_NR
  line 0
   mode e1oip
   e1oip local LOCAL_IP LOCAL_PORT
   e1oip remote HUB_IP HUB_PORT

Where you need to substitute the upper-case terms as follows:

Variable	Description
SERIAL_NR	The serial number string (iSerial) of your device as visible for example using lsusb -v -d 1d50:6145. Should be a hex digit sequence like dc697407e74f292
LOCAL_IP	The local IP address to be used by osmo-e1d for this line
LOCAL_PORT	The local UDP port to be used by osmo-e1d for this line
HUB_IP	The remot IP address to be used by osmo-e1d for this line. Provided by laforge
HUB_PORT	The remote UDP port to be used by osmo-e1d for this line. Provided by laforge

Checking status¶

osmo-e1d like most Osmocom software offers a cisco style command line interface called VTY. The VTY of osmo-e1d listens to localhost:4269, so you can use telnet localhost 4269 to reach it. Check commands like show line, show interface and show stats for start.

GPS lock status¶

To avoid cycle slips, the GPS-DO needs a proper GPS fix

osmo-e1d> show interface 
Interface #0 (dc697407e74f2922), Driver: usb
 GPS-DO: mode=AUTO, fix=TRUE, state=TUNE_FINE antenna=OK, tune=2055/2078, freq_est=30720000

If things are good, the state should be TUNE_FINE and antenna=OK. If you see other output, please check your antenna setup.