frappy/doc/source/protocol/issue_10.rst
Markus Zolliker 8663501150 revision of SECoP documentation
- created secop_v2017-09-14.rst, based on the GoogleDocs
  SECoP Preliminary V2016-11-30 (rc 2)
- this Document is supposed to contain the full SECoP standard
- created SECoP issues
- moved everything else to "outdated" (kept for reference)

Change-Id: I87d69d1846fc4ed55f1c78b22fd4650d8550152b
Reviewed-on: https://forge.frm2.tum.de/review/16573
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
2017-11-03 08:46:20 +01:00

46 lines
1.5 KiB
ReStructuredText

SECoP Issue 10: Character set for Names (under discussion)
==========================================================
Uppercase Characters in Identifiers
-----------------------------------
Actually (V2017-09-14), the following is specified;
The identifiers are composed by
lowercase ascii letters, digits and underscore, where a digit may not
appear as the first character. Identifiers starting with underscore are
reserved for special purposes like internal use for debugging. The
identifier length is limited (<=63 characters).
In the outdated part of the documentation (`outdated Messages`_) it is not
explicitly stated, that identifiers have to be lower case, and also
in some of the running examples contain uppercase identifiers.
.. _`outdated Messages`: messages.html
Discussion
~~~~~~~~~~
Markus:
For me, it is not that important, if uppercase characters are allowed or not, but,
identifiers must be unique independent of case, i.e. it is not allowed to have two
different modules "t" and "T", on a SEC node. And we should take a decision soon.
Default parameters 'value' and 'target'
---------------------------------------
In the implementation, in the "read" and "update" messages "<module>:value" can be just
replaced by "<module>", and in "change" and "changed" message "<module>:target" can
be replaced by "<module>".
Discussion
~~~~~~~~~~
Markus:
I prefer not to allow these shortcuts. We also have to distinguish module properties
from properties of the module parameter 'value'.