path: root/doc
diff options
authorMax <msuraev@sysmocom.de>2016-05-04 14:30:49 +0200
committerNeels Hofmeyr <neels@hofmeyr.de>2018-11-27 17:12:40 +0100
commit2e904b13854480733d37790dadb8a1fc01c17398 (patch)
treee1b47a1a814b351b3903627cd16cf78356523862 /doc
parenta412d9041fe6819e3344037662dcf44e6dbb4229 (diff)
Add OsmoBSC control interface description
Diffstat (limited to 'doc')
1 files changed, 22 insertions, 0 deletions
diff --git a/doc/manuals/chapters/overview.adoc b/doc/manuals/chapters/overview.adoc
index b6cc2e888..6577df823 100644
--- a/doc/manuals/chapters/overview.adoc
+++ b/doc/manuals/chapters/overview.adoc
@@ -67,3 +67,25 @@ codec frames are passed through transparently. In order to achieve this
with E1 based BTS, OsmoBSC contains a E1 sub-channel de- and
re-multiplexer as well as a TRAU mapper that can map uplink to downlink
frames and vice versa.
+=== Control interface
+The actual protocol is described in <<common-control-if>> section. Here we
+describe variables specific to OsmoBSC.
+.Variables available over control interface
+|msc_connection_status|RO|Yes|"connected", "disconnected"|Indicate the status of connection to MSC.
+|bts_connection_status|RO|Yes|"connected", "disconnected"|Indicate the status of connection to BTS.
+|location|RW|Yes|"<unixtime>,(invalid\|fix2d\|fix3d),<lat>,<lon>,<height>"|Set/Get location data.
+|timezone|RW|No|"<hours>,<mins>,<dst>", "off"|-19 <= hours <= 19, mins in {0, 15, 30, 45}, and 0 <= dst <= 2
+Some comments.
+FIXME: commands defined in src/ctrl/control_if.c? Nodes? Traps?