Skip to content

Commit

Permalink
Documentation. Removed container elements from element description. I…
Browse files Browse the repository at this point in the history
…t is defined in the heading and shown in the examples. Fixed some typos
  • Loading branch information
Krolken committed Jan 14, 2019
1 parent 05261e8 commit 9eae4f1
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 32 deletions.
1 change: 1 addition & 0 deletions docs/source/index.rst
Expand Up @@ -9,6 +9,7 @@ Welcome to sos-access's documentation!
.. toctree::
:maxdepth: 2
:caption: Contents:
:numbered:

usage
sos_access_protocol
Expand Down
32 changes: 8 additions & 24 deletions docs/source/sos_access_protocol.rst
Expand Up @@ -8,7 +8,7 @@ alarm transmitters and receivers.

Functions for monitoring the transmission link are included.

It is an XML based protocol and nly printable 8-bits characters from
It is an XML based protocol and only printable 8-bits characters from
ISO8859-1 are allowed.

The protocol consists of the following message types:
Expand Down Expand Up @@ -77,9 +77,6 @@ Alarm Requests <alarmrequest>
Element definitions
^^^^^^^^^^^^^^^^^^^

<alarmrequest>
| Containing element of the alarm request
<reference>
| OPTIONAL
| 1-50 Characters
Expand Down Expand Up @@ -193,13 +190,13 @@ Element definitions
:caption: WGS84
<position>
<pos>E597295E0176288</pos>
<pos>N597295E0176288</pos>
</position>
.. todo::

Contact SOS Alarm and clarify what happens when an alarm transmitter has a
position in the recieving system but a different one is provided via the
position in the receiving system but a different one is provided via the
alarm.


Expand Down Expand Up @@ -258,9 +255,6 @@ Alarm Response <alarmresponse>
Element definitions
^^^^^^^^^^^^^^^^^^^

<alarmresponse>
| Containing element of the alarm response
<reference>
| OPTIONAL
| 1-50 Characters
Expand Down Expand Up @@ -326,7 +320,7 @@ alarm operators customer support for a new password.

If the transmitter is replaced a new password is required from alarm operator.

The change off passoword is requested with <requestnewauthentication> and the
The change off password is requested with <requestnewauthentication> and the
response <requestnewauthenticationresponse> is sent back containing the new
password.

Expand All @@ -336,9 +330,6 @@ New Auth Request <requestnewauthentication>
Element definitions
^^^^^^^^^^^^^^^^^^^

<requestnewauthentication>
| Containing element of the new auth request
<authentication>
| 15 Characters
| Authentication (current password)
Expand Down Expand Up @@ -378,9 +369,6 @@ New Auth Response <requestnewauthenticationresponse>
Element definitions
^^^^^^^^^^^^^^^^^^^

<requestnewauthenticationresponse>
| Containing element of the new auth response
<reference>
| 1-50 Characters
| See :ref:`alarm-request`
Expand Down Expand Up @@ -443,13 +431,15 @@ Each service level requires that at least two heartbeat signals shall be sent
within the interval.

It is recommend that the transmitter sends at least three heartbeat signals per
servicelevel time but no more than six.
service level time but no more than six.


.. todo::

There is a protection if sending <pingrequest> very shortly a after each
other that the server responds with PING_TO_OFTEN. What is this exact timelimit? Contact SOS Alarm and ask.
other that the server responds with PING_TO_OFTEN. What is this exact
time limit since it doesn't seem to be bound to the service level?
Contact SOS Alarm and ask.

If heartbeat signals is sent to frequent an error message will be replied in the
ping request response (PING_TO_OFTEN).
Expand All @@ -468,9 +458,6 @@ Ping Request <pingrequest>
Element definitions
^^^^^^^^^^^^^^^^^^^

<pingrequest>
| Containing element of the ping request
<authentication>
| 15 Characters
| Authentication (current password)
Expand Down Expand Up @@ -509,9 +496,6 @@ Ping Response <pingresponse>
Element definitions
^^^^^^^^^^^^^^^^^^^

<pingresponse>
| Containing element of the ping response
<reference>
| 1-50 Characters
| See :ref:`alarm-request`
Expand Down
9 changes: 1 addition & 8 deletions docs/source/usage.rst
Expand Up @@ -39,11 +39,6 @@ For creating clients that sends the alarms encrypted to the alarm receiver set u
use_tls=True
)
.. note::

The client will make a new TCP session for every transmission so not to create a lot of
open sockets on the receiver.

===============
Send an Alarm
Expand Down Expand Up @@ -99,8 +94,6 @@ Ping is sent via the .ping() method.
==============================
Change password of transmitter
==============================
Expand Down Expand Up @@ -132,7 +125,7 @@ The client implements a retry functionality between the primary and secondary
alarm receiver.

In the specification of the SOS Access v4 protocol there is nothing hindering
the client from keep alternatly retrying each server for ever. But this is not
the client from keep alternately retrying each server for ever. But this is not
practical. The standard value of retry for the client is 3 times on each receiver.

If you need to change this then subclass the client and change MAX_RETRY
Expand Down

0 comments on commit 9eae4f1

Please sign in to comment.