diff --git a/docs/source/index.rst b/docs/source/index.rst index aa65e1e..93e5f7b 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -9,6 +9,7 @@ Welcome to sos-access's documentation! .. toctree:: :maxdepth: 2 :caption: Contents: + :numbered: usage sos_access_protocol diff --git a/docs/source/sos_access_protocol.rst b/docs/source/sos_access_protocol.rst index 9682f04..28c312b 100644 --- a/docs/source/sos_access_protocol.rst +++ b/docs/source/sos_access_protocol.rst @@ -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: @@ -77,9 +77,6 @@ Alarm Requests Element definitions ^^^^^^^^^^^^^^^^^^^ - - | Containing element of the alarm request - | OPTIONAL | 1-50 Characters @@ -193,13 +190,13 @@ Element definitions :caption: WGS84 - E597295E0176288 + N597295E0176288 .. 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. @@ -258,9 +255,6 @@ Alarm Response Element definitions ^^^^^^^^^^^^^^^^^^^ - - | Containing element of the alarm response - | OPTIONAL | 1-50 Characters @@ -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 and the +The change off password is requested with and the response is sent back containing the new password. @@ -336,9 +330,6 @@ New Auth Request Element definitions ^^^^^^^^^^^^^^^^^^^ - - | Containing element of the new auth request - | 15 Characters | Authentication (current password) @@ -378,9 +369,6 @@ New Auth Response Element definitions ^^^^^^^^^^^^^^^^^^^ - - | Containing element of the new auth response - | 1-50 Characters | See :ref:`alarm-request` @@ -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 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). @@ -468,9 +458,6 @@ Ping Request Element definitions ^^^^^^^^^^^^^^^^^^^ - - | Containing element of the ping request - | 15 Characters | Authentication (current password) @@ -509,9 +496,6 @@ Ping Response Element definitions ^^^^^^^^^^^^^^^^^^^ - - | Containing element of the ping response - | 1-50 Characters | See :ref:`alarm-request` diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 839340b..b633264 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -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 @@ -99,8 +94,6 @@ Ping is sent via the .ping() method. - - ============================== Change password of transmitter ============================== @@ -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