Getting Started » History » Revision 8
Revision 7 (laforge, 03/10/2022 10:01 AM) → Revision 8/11 (laforge, 03/10/2022 10:03 AM)
{{>toc}}
h1. 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.
h2. Required Hardware
* [[e1-t1-adapter:ICE40_E1_USB_interface|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 [[e1-t1-adapter:Isochronous_USB_Issues]] for details. If you have a system with UHCI/OHCI/EHCI, use that.
h2. Major steps required for setup
# Installing latest gateware and firmware into the icE1usb
# building + installing the @laforge/e1oip@ branch of [[osmo-e1d:]]
# requesting a connection with the OCTOI hub
# creating a config file for @osmo-e1d@
# possibly adding a port forward in your router
h3. Installing latest gateware and firmware into the icE1usb
Please follow the instructions of the "icE1usb user manaul":https://downloads.osmocom.org/docs/latest/icE1usb-usermanual.pdf
Firmware is available from https://downloads.osmocom.org/binaries/icE1usb/firmware/all/
You will need "dfu-util":http://dfu-util.sourceforge.net/ for performing the USB device firmware upgrade. Most distributions should have a package for this.
h3. 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.
h4. 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@).
h4. building
<pre>
autoreconf -fi
./configure
make
</pre>
h4. 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.
<pre>
make install
</pre>
h3. requesting connection
Please contact @laforge with your IP address and port number. *Right now the protocol does not yet support dynamic IP addresses.*
h3. 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@.
<pre>
e1d
interface 0 icE1usb
usb-serial SERIAL_NR
line 0
mode e1oip
e1oip local LOCAL_IP LOCAL_PORT
e1oip remote HUB_IP HUB_PORT
</pre>
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|
h2. 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.
