summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorOliver Smith <osmith@sysmocom.de>2018-11-29 10:52:42 +0100
committerOliver Smith <osmith@sysmocom.de>2018-11-29 10:52:42 +0100
commitceb12eaa695009edcc74e714ddae518ac1652992 (patch)
treee478fe65897c25481eae9c6748e35f63b912f94a
parentb7f198f08709fcc7a202bd446beeb17623c5cfea (diff)
remove OsmocomBB files (now avail in osmocom-bb.git)
Files were added in osmocom-bb.git Change-Id I7d1226d3865da9595b730b716a8d4ba07be1e0d5 Depends: osmocom-bb.git Change-Id I7d1226d3865da9595b730b716a8d4ba07be1e0d5 Related: OS#3385 Change-Id: I5a4839be7a3122ab566023a3e7b3bc955db98ba4
-rw-r--r--Makefile.am3
-rw-r--r--OsmocomBB/Makefile.am10
-rw-r--r--OsmocomBB/chapters/scripting.adoc111
-rw-r--r--OsmocomBB/osmocombb-usermanual-docinfo.xml57
-rw-r--r--OsmocomBB/osmocombb-usermanual.adoc21
-rw-r--r--configure.ac3
6 files changed, 2 insertions, 203 deletions
diff --git a/Makefile.am b/Makefile.am
index 26a06a3..64623af 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -7,8 +7,7 @@ BUILT_SOURCES = $(top_srcdir)/.version
EXTRA_DIST = git-version-gen .version check-depends.sh $(share_files)
SUBDIRS = tests \
OsmoMGCP \
- OsmoNAT \
- OsmocomBB
+ OsmoNAT
$(top_srcdir)/.version:
echo $(VERSION) > $@-t && mv $@-t $@
diff --git a/OsmocomBB/Makefile.am b/OsmocomBB/Makefile.am
deleted file mode 100644
index 61ccafa..0000000
--- a/OsmocomBB/Makefile.am
+++ /dev/null
@@ -1,10 +0,0 @@
-OSMO_GSM_MANUALS_DIR = $(top_srcdir)
-EXTRA_DIST = osmocombb-usermanual.adoc \
- osmocombb-usermanual-docinfo.xml \
- chapters
-
-ASCIIDOC = osmocombb-usermanual.adoc
-ASCIIDOC_DEPS = $(srcdir)/chapters/*.adoc
-include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.asciidoc.inc
-
-include $(OSMO_GSM_MANUALS_DIR)/build/Makefile.common.inc
diff --git a/OsmocomBB/chapters/scripting.adoc b/OsmocomBB/chapters/scripting.adoc
deleted file mode 100644
index 8828a72..0000000
--- a/OsmocomBB/chapters/scripting.adoc
+++ /dev/null
@@ -1,111 +0,0 @@
-[[scripting]]
-== Scripting using Lua
-
-The mobile application can be extended using the
-https://www.lua.org/manual/5.3/[lua5.3 language].
-To use the scripting facility a script needs to be
-configured through the VTY interface and will be
-associated to a Mobile Station (MS). The script will
-then be able to interact with the specific MS.
-
-An event based programming model is to be used. This
-means that once the script has been loaded it should
-register to the wanted events, configure timers and
-return. When an event occurs the registered event
-handler will be executed.
-
-The following describes the exported runtime services
-to be used in the script.
-
-=== Logging
-
-The logging functions allow to generate log messages
-for different levels. The log implementatiom is using
-the standard Osmocom logging framework which allows to
-have multiple log targets, e.g. syslog, file or through
-the VTY.
-
-|========
-|Code |Return | Explanation
-|print(...) |void | Print a message with log level 'debug'
-|log_debug(...) |void | Print a message with log level 'debug'
-|log_notice(...) |void | Print a message with log level 'notice'
-|log_error(...) |void | Print a message with log level 'error'
-|log_fatal(...) |void | Print a message with log level 'fatal'
-|========
-
-==== Examples
-
-----
-Code:
-print("Log level 'debug'")
-log_debug("Log level 'debug'")
-log_notice("Log level 'notice'")
-log_error("Log level 'error'")
-log_fatal("Log level 'fatal'")
-
-Output:
-\<0011> @script.lua:1 Log level 'debug'
-\<0011> @script.lua:2 Log level 'debug'
-\<0011> @script.lua:3 Log level 'notice'
-\<0011> @script.lua:4 Log level 'error'
-\<0011> @script.lua:5 Log level 'fatal'
-
-----
-
-=== Timer class
-
-The timer allows to invoke a function once after the requested
-timeout. The timer creation function will return immediately and
-the callback will be called after the timeout and when no other
-lua code is executing. The _osmo.timeout_ function should be used
-to create a new time, a running timer can be canneled using the _cancel_
-method.
-
-|========
-|Code |Return |Explanation
-|osmo.timeout(timeout, cb)|A new timer|Create a new non-recurring timer. Timeout should be in rounded seconds and cb should be a function.
-|timer.cancel() |Void |Cancel the timer, the callback will not be called.
-|========
-
-==== Examples
-
-----
-Code:
-local timer = osmo.timeout(timeout_in_seconds, call_back)
-timer:cancel()
-----
-
-----
-Code:
-local timer = osmo.timeout(3, function()
- print("Timeout passed")
-end)
-print("Configured")
-
-Output:
-\<0011> @script.lua:4 Configured
-\<0011> @script.lua:2 Timeout passed
-----
-
-=== MS class
-
-The MS singletong provides access to the Mobile Station configuration
-the script is associated with. This includes runtime information like
-the IMSI, IMEI or functions like start/stop.
-
-|========
-|Code |Return |Explanation
-|osmo.ms().imsi() |string |The IMSI. It might be invalid in case it has not been read from SIM card yet
-|osmo.ms().imei() |string |The configured IMEI
-|========
-==== Examples
-
------
-Code:
-local ms = osmo.ms()
-print(ms.imei(), ms.imsi())
-
-Output:
-\<0011> @script.lua:2 126000000000000
------
diff --git a/OsmocomBB/osmocombb-usermanual-docinfo.xml b/OsmocomBB/osmocombb-usermanual-docinfo.xml
deleted file mode 100644
index 992a42e..0000000
--- a/OsmocomBB/osmocombb-usermanual-docinfo.xml
+++ /dev/null
@@ -1,57 +0,0 @@
-<revhistory>
- <revision>
- <revnumber>1</revnumber>
- <date>November 2017</date>
- <authorinitials>HHPF</authorinitials>
- <revremark>
- Initial version.
- </revremark>
- </revision>
- </revhistory>
-
-<authorgroup>
- <author>
- <firstname>Harald</firstname>
- <surname>Welte</surname>
- <email>hwelte@sysmocom.de</email>
- <authorinitials>HW</authorinitials>
- <affiliation>
- <shortaffil>sysmocom</shortaffil>
- <orgname>sysmocom - s.f.m.c. GmbH</orgname>
- <jobtitle>Managing Director</jobtitle>
- </affiliation>
- </author>
- <author>
- <firstname>Holger</firstname>
- <surname>Freyther</surname>
- <email>hfreyther@sysmocom.de</email>
- <authorinitials>HHPF</authorinitials>
- <affiliation>
- <shortaffil>sysmocom</shortaffil>
- <orgname>sysmocom - s.f.m.c. GmbH</orgname>
- <jobtitle>Co-Founder</jobtitle>
- </affiliation>
- </author>
-</authorgroup>
-
-<copyright>
- <year>2013-2017</year>
- <holder>sysmocom - s.f.m.c. GmbH</holder>
-</copyright>
-
-<legalnotice>
- <para>
- Permission is granted to copy, distribute and/or modify this
- document under the terms of the GNU Free Documentation License,
- Version 1.3 or any later version published by the Free Software
- Foundation; with no Invariant Sections, no Front-Cover Texts,
- and no Back-Cover Texts. A copy of the license is included in
- the section entitled "GNU Free Documentation License".
- </para>
- <para>
- The Asciidoc source code of this manual can be found at
- <ulink url="http://git.osmocom.org/osmo-gsm-manuals/">
- http://git.osmocom.org/osmo-gsm-manuals/
- </ulink>
- </para>
-</legalnotice>
diff --git a/OsmocomBB/osmocombb-usermanual.adoc b/OsmocomBB/osmocombb-usermanual.adoc
deleted file mode 100644
index 024fc79..0000000
--- a/OsmocomBB/osmocombb-usermanual.adoc
+++ /dev/null
@@ -1,21 +0,0 @@
-OsmocomBB User Manual
-=====================
-Holger Hans Peter Freyther <holger@moiji-mobile.com>
-
-
-include::./common/chapters/preface.adoc[]
-
-include::{srcdir}/chapters/scripting.adoc[]
-
-include::./common/chapters/vty.adoc[]
-
-include::./common/chapters/logging.adoc[]
-
-
-include::./common/chapters/port_numbers.adoc[]
-
-include::./common/chapters/bibliography.adoc[]
-
-include::./common/chapters/glossary.adoc[]
-
-include::./common/chapters/gfdl.adoc[]
diff --git a/configure.ac b/configure.ac
index cfd2971..764da31 100644
--- a/configure.ac
+++ b/configure.ac
@@ -29,5 +29,4 @@ AC_OUTPUT(
Makefile
tests/Makefile
OsmoMGCP/Makefile
- OsmoNAT/Makefile
- OsmocomBB/Makefile)
+ OsmoNAT/Makefile)