Skip to content

Fix ABNF missing example changes and improve readability by splitting long construct. #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HansBusch merged 6 commits into from
Apr 26, 2021
+22 −18
Merged

Fix ABNF missing example changes and improve readability by splitting long construct. #98

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
fc79f42
Fix ABNF missing example changes.
HansBusch Apr 9, 2021
4ee0eab
Improve readability by splitting long construct.
HansBusch Apr 9, 2021
9ece3da
Change ABNF code to programlisting.
HansBusch Apr 9, 2021
fdbea43
Replace curved double quotes in ABNF by simple double quotes.
HansBusch Apr 12, 2021
3b926d6
Align example output with analytics spec.
HansBusch Apr 12, 2021
4695ccc
Remove superfluous curly bracket in JSON example
svefredrik Apr 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 22 additions & 18 deletions doc/Core.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7362,29 +7362,31 @@ http://www.onvif.org/ver10/tev/topicExpression/ConcreteSet
</section>
<section>
<title>JSON Event Payload</title>
<para>This section describes how an ONVIF event is mapped to the JSON data format when published using the “onvif-ej” payload definition. <phrase>Mapping definition from XML to JSON according to RFC 5234:</phrase></para>
<para>MESSAGE ::= “{“ TIMEINFO *(“,” ITEM) “}”</para>
<para>TIMEINFO ::= DQUOTE “UtcTime” DQUOTE “:” TIMESTAMP </para>
<para>This section describes how an ONVIF event is mapped to the JSON data format when published using the "onvif-ej" payload definition. <phrase>Mapping definition from XML to JSON according to RFC 5234:</phrase></para>
<para>MESSAGE ::= "{" TIMEINFO "," SOURCE ["," DATA ] "}"</para>
<para>TIMEINFO ::= DQUOTE "UtcTime" DQUOTE ":" TIMESTAMP </para>
<para>SOURCE ::= DQUOTE "Source" DQUOTE ":" "{" *(ITEM) "}"</para>
<para>DATA ::= DQUOTE "Data" DQUOTE ":" "{" *(ITEM) "}"</para>
<para>ITEM ::= SIMPLEITEM / ELEMENTITEM</para>
<para>SIMPLEITEM ::= DQUOTE SNAME DQUOTE ”:” DQUOTE SVALUE DQUOTE</para>
<para>ELEMENTITEM ::= DQUOTE ENAME DQUOTE “: {“ [ TYPE *(“,” TYPE)] “}”</para>
<para>SIMPLEITEM ::= DQUOTE SNAME DQUOTE ":" DQUOTE SVALUE DQUOTE</para>
<para>ELEMENTITEM ::= DQUOTE ENAME DQUOTE ": {" [ TYPE *("," TYPE)] "}"</para>
<para>TYPE ::= ATTRIBUTE / SIMPLETYPE / COMPLEXTYPE</para>
<para>ATTRIBUTE ::= DQUOTE ANAME DQUOTE ”: ” DQUOTE AVALUE DQUOTE</para>
<para>SIMPLETYPE ::= DQUOTE NAME DQUOTE ”: ” DQUOTE VALUE DQUOTE</para>
<para>COMPLEXTYPE ::= DQUOTE NAME DQUOTE ”: {“ [TYPE *(“,” TYPE)] “}”</para>
<para>ATTRIBUTE ::= DQUOTE ANAME DQUOTE ": " DQUOTE AVALUE DQUOTE</para>
<para>SIMPLETYPE ::= DQUOTE NAME DQUOTE ": " DQUOTE VALUE DQUOTE</para>
<para>COMPLEXTYPE ::= DQUOTE NAME DQUOTE ": {" [TYPE *("," TYPE)] "}"</para>
<para>with </para>
<itemizedlist>
<listitem>
<para>TIMESTAMP being the double quoted UTC timestamp of the XML Message UtcTime element</para>
</listitem>
<listitem>
<para>SNAME being the value of the “Name” attribute of the SimpleItem</para>
<para>SNAME being the value of the Name attribute of the SimpleItem</para>
</listitem>
<listitem>
<para>SVALUE being the value of the “Value” attribute of the SimpleItem</para>
<para>SVALUE being the value of the Value attribute of the SimpleItem</para>
</listitem>
<listitem>
<para>ENAME being the value of the “Name” attribute of the ElementItem</para>
<para>ENAME being the value of the Name attribute of the ElementItem</para>
</listitem>
<listitem>
<para>ANAME being the name of the attribute of the corresponding XML attribute</para>
Expand Down Expand Up @@ -7413,26 +7415,28 @@ Payload:
{
"UtcTime": "2008-10-10T12:24:57.321Z",
"Source": {
"VideoSourceConfigurationToken": "1",
"VideoAnalyticsConfigurationToken": "2",
"VideoSource": "1",
"AnalyticsConfiguration": "2",
"Rule": "MyImportantFence1"
},
"Data": {
"ObjectId": "15" }
}}
"ObjectId": "15"
}
}

Topic:
MyDevice/onvif-ej/RuleEngine/LineDetector/Crossed/&amp;1/2/MyImportantFence2Payload:
Payload:
{
"UtcTime": "2008-10-10T12:24:57.789Z
"Source": {
"VideoSourceConfigurationToken": "1",
"VideoAnalyticsConfigurationToken": "2",
"VideoSource": "1",
"Rule": "MyImportantFence2"
},
"Data": {
"ObjectId": "19"
} }
}
}
</programlisting>
</section>
</section>
Expand Down