Project

General

Profile

Getting Started » History » Version 8

laforge, 03/10/2022 10:03 AM

1 2 laforge
{{>toc}}
2
3 1 laforge
h1. Getting Started
4
5
This page is a work-in-progress documenting what you need to do to get connected to the [[Community_TDMSS7_Network]] using an icE1usb.
6
7
h2. Required Hardware
8
9
* [[e1-t1-adapter:ICE40_E1_USB_interface|icE1usb]] hardware (contact @sales@sysmocom.de@ for an OCTOI community special price of EUR 75)
10
* GPS antenna with SMA male plug (not included)
11
* 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.
12
* 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.
13
14
h2. Major steps required for setup
15
16
# Installing latest gateware and firmware into the icE1usb
17 3 laforge
# building + installing the @laforge/e1oip@ branch of [[osmo-e1d:]]
18 1 laforge
# requesting a connection with the OCTOI hub
19
# creating a config file for @osmo-e1d@
20
# possibly adding a port forward in your router
21 2 laforge
22
h3. Installing latest gateware and firmware into the icE1usb
23
24
Please follow the instructions of the "icE1usb user manaul":https://downloads.osmocom.org/docs/latest/icE1usb-usermanual.pdf
25
26
Firmware is available from https://downloads.osmocom.org/binaries/icE1usb/firmware/all/
27
28
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.
29
30 3 laforge
h3. building + installing the @laforge/e1oip@ branch of [[osmo-e1d:]]
31 2 laforge
32 4 laforge
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.
33 2 laforge
34
h4. dependencies
35
36
You will need
37
* build-essential (gcc, binutils, make, ...)
38
* autotools (autoconf, automake)
39
* libtool
40
* pkg-config
41
* talloc
42
* libosmocore
43
* libusb-1.0
44
45
If using distribution packages, make sure you install the _development_ packages (e.g. @libtalloc-dev@).
46
47
h4. building
48
49
<pre>
50
autoreconf -fi
51
./configure
52
make
53
</pre>
54
55
h4. installation (optional)
56
57
you can run osmo-e1d from the build directory, there's no strict need to install it.
58
59
If you do install it using the below instructions, the binary will be in @/usr/local/bin@ or whatever is configured at configure time.
60
61
<pre>
62
make install
63
</pre>
64
65
h3. requesting connection
66
67
Please contact @laforge with your IP address and port number.  *Right now the protocol does not yet support dynamic IP addresses.*
68
69
h3. creating a config file
70 5 laforge
71 7 laforge
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@.
72 6 laforge
73
<pre>
74
e1d
75
 interface 0 icE1usb
76
  usb-serial SERIAL_NR
77
  line 0
78
   mode e1oip
79
   e1oip local LOCAL_IP LOCAL_PORT
80
   e1oip remote HUB_IP HUB_PORT
81
</pre>
82
83
Where you need to substitute the upper-case terms as follows:
84
85
|_.Variable|_.Description|
86
|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@|
87
|LOCAL_IP|The local IP address to be used by osmo-e1d for this line|
88
|LOCAL_PORT|The local UDP port to be used by osmo-e1d for this line|
89
|HUB_IP|The remot IP address to be used by osmo-e1d for this line. Provided by @laforge|
90
|HUB_PORT|The remote UDP port to be used by osmo-e1d for this line. Provided by @laforge|
91 8 laforge
92
h2. Checking status
93
94
@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.
Add picture from clipboard (Maximum size: 48.8 MB)