cellular-infrastructure
/
osmo-cbc
mirror of https://gerrit.osmocom.org/osmo-cbc
9
0
Fork 0
Code Issues Releases Wiki Activity

manual: Document cbc-apitool.py 

Change-Id: I2a65e7a582c8bb72d80731fb6e77a796ae4f9b4c
This commit is contained in:
Harald Welte 2021-01-24 14:23:53 +01:00
parent 071a60e465
commit 2b158c3b2d
2 changed files with 81 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

79
doc/manuals/chapters/cbc-apitool.adoc Normal file
View File

@ -0,0 +1,79 @@
[[apitool]]
== `cbc-apitool.py`
`cbc-apitool.py` is a very simple/basic python3 script that can be used
to demonstrate the use of the ECBE REST interface (<<ecbe>>) from the
command line.
It uses the python3 standard librariy `requests` in order to issue ECBE
API request over HTTP towards osmo-cbc.
`cbc-apitool.py` has a couple of sub-commands, each of which offer
=== Common options
*-h, --help*::
Print a short help message about the supported common options.
*-H, --host HOST*::
Remote host name/IP to which to connect (typically your ECBE
bind address of osmo-cbc). Default: 127.0.0.1.
*-p, --port PORT*::
Remote TCP port number to which to connect (typically your ECBE
bind address of osmo-cbc). Default: 12345
*-v, --verbose*::
Print some more verbose information like the HTTP requests
and responses during execution.
=== `create-cbs`: Creating a new CBS message
You can create a new CBS message using `cbc-apitool create-cbs`.
==== `create-cbs` Options
*-h, --help*::
Print a short help message about the supported create-cbs options.
*--msg-id MSG_ID*::
Specify the message ID of the to-be-created CBS
message. Range: 0..65535
*--msg-code MSG_CODE*::
Specify the message code (part of the serial number). Range:
0..1023. Default: 768
*--update-nr UPDATE_NR*::
Specify the update number (part of the serial number). Range:
0..15. Default: 0
*--repetition-period REPETITION_PERIOD*::
How frequently this message shall be repeated (in number of CBCH
slots). Default: 5
*--num-of-bcast NUM_OF_BCAST*::
Number of times this message shall be broadcast (Default: 999).
*--payload-data-utf8 PAYLOAD_DATA_UTF8*::
Payload data (typically text message) in UTF8 encoding. Will be
transcoded to 7bit GSM alphabet internally.
==== `create-etws` Options
*-h, --help*::
Print a short help message about the supported create-cbs options.
*--msg-id MSG_ID*::
Specify the message ID of the to-be-created CBS
message. Range: 0..65535
*--msg-code MSG_CODE*::
Specify the message code (part of the serial number). Range:
0..1023. Default: 768
*--update-nr UPDATE_NR*::
Specify the update number (part of the serial number). Range:
0..15. Default: 0
*--repetition-period REPETITION_PERIOD*::
How frequently this message shall be repeated (in number of CBCH
slots). Default: 5
*--num-of-bcast NUM_OF_BCAST*::
Number of times this message shall be broadcast (Default: 999).
==== `delete` Options
*--msg-id MSG_ID*::
Specify the message ID of the to-be-created CBS
message. Range: 0..65535

2
doc/manuals/osmocbc-usermanual.adoc
View File

@ -18,6 +18,8 @@ include::{srcdir}/chapters/introspection.adoc[]
include::{srcdir}/chapters/ecbe-rest-interface.adoc[]
include::{srcdir}/chapters/cbc-apitool.adoc[]
include::./common/chapters/counters-overview.adoc[]
include::{srcdir}/chapters/counters.adoc[]