Skip to content
This repository was archived by the owner on Jun 17, 2024. It is now read-only.

Commit f792cd3

Browse files
Update README.md
1 parent 555a7c8 commit f792cd3

File tree

1 file changed

+45
-6
lines changed

1 file changed

+45
-6
lines changed

README.md

Lines changed: 45 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
11
# Common Alerting Procotol (CAP) Parser
22

3-
## CAP (De)Parser
4-
5-
6-
73
## What is CAP ?
84

95
> *The Common Alerting Protocol (CAP), a digital format for exchanging emergency alerts, allows a consistent alert message to be disseminated simultaneously over multiple communications pathways.*
@@ -26,7 +22,7 @@ It was developed by **Oasis Open**, and full specifications can be found [here](
2622

2723
### Example
2824

29-
```` XML
25+
``` XML
3026
<alert xmlns="urn:oasis:names:tc:emergency:cap:1.2">
3127
<identifier>43b080713727</identifier>
3228
<sender>hsas@dhs.gov</sender>
@@ -64,4 +60,47 @@ It was developed by **Oasis Open**, and full specifications can be found [here](
6460
</area>
6561
</info>
6662
</alert>
67-
````
63+
```
64+
65+
## How to Use
66+
67+
``` Python
68+
import capparser
69+
70+
alert = capparser.element.Alert(sender="FireTec",
71+
status=capparser.enums.Status.Actual,
72+
msgType=capparser.enums.MsgType.Alert,
73+
scope=capparser.enums.Scope.Private)
74+
alert.setSource("FireTec")
75+
alert.addAddress("Radio Renascenca")
76+
77+
info = capparser.element.Info(category=[capparser.enums.Category.Fire],
78+
event="Incendio Florestal em Sever do Vouga",
79+
urgency=capparser.enums.Urgency.Immediate,
80+
severity=capparser.enums.Severity.Severe,
81+
certainty=capparser.enums.Certainty.Observed)
82+
info.setSenderName("FireTec")
83+
info.setInstruction(
84+
"Foi detetado um possivel incendio florestal na sua area, precaucao e aconselhada.")
85+
86+
param1 = capparser.element.Parameter(parameterName="PS",
87+
parameterValue="PS=Radio Renascenca")
88+
param2 = capparser.element.Parameter(parameterName="PI",
89+
parameterValue="PI=80XX")
90+
param3 = capparser.element.Parameter(parameterName="AF",
91+
parameterValue="AF=95.0")
92+
param4 = capparser.element.Parameter(parameterName="AF",
93+
parameterValue="AF=100.0")
94+
param5 = capparser.element.Parameter(parameterName="AF",
95+
parameterValue="AF=105.0")
96+
97+
info.addParameter(param1)
98+
info.addParameter(param2)
99+
info.addParameter(param3)
100+
info.addParameter(param4)
101+
info.addParameter(param5)
102+
103+
alert.addInfo(info)
104+
105+
capparser.writeAlertToFile(alert, "output.xml")
106+
```

0 commit comments

Comments
 (0)