-
Notifications
You must be signed in to change notification settings - Fork 210
/
Copy pathcfe_evs.xml
1342 lines (1161 loc) · 59.4 KB
/
cfe_evs.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0" encoding="UTF-8"?>
<!--
NASA Docket No. GSC-18,719-1, and identified as “core Flight System: Bootes”
Copyright (c) 2020 United States Government as represented by the
Administrator of the National Aeronautics and Space Administration.
All Rights Reserved.
Licensed under the Apache License, Version 2.0 (the "License"); you may
not use this file except in compliance with the License. You may obtain
a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
This document adheres to the Electronic Data Sheet (EDS) XML schema
as prescribed in CCSDS book 876.0.
Purpose:
This describes all interface objects for the Event Services (CFE_EVS)
core application
-->
<PackageFile xmlns="http://www.ccsds.org/schema/sois/seds">
<Package name="CFE_EVS" shortDescription="NASA Core Flight System Event Services">
<DataTypeSet>
<EnumeratedDataType name="MsgFormat" shortDescription="Identifies format of log messages">
<IntegerDataEncoding sizeInBits="8" encoding="unsigned" />
<EnumerationList>
<Enumeration label="SHORT" value="0" shortDescription="Short Format Log Messages" />
<Enumeration label="LONG" value="1" shortDescription="Long Format Log Messages" />
</EnumerationList>
</EnumeratedDataType>
<EnumeratedDataType name="LogMode" shortDescription="Identifies handling of log messages after storage is filled" >
<IntegerDataEncoding sizeInBits="8" encoding="unsigned" />
<EnumerationList>
<Enumeration label="OVERWRITE" value="0" shortDescription="Overwrite Log Mode" />
<Enumeration label="DISCARD" value="1" shortDescription="Discard Log Mode" />
</EnumerationList>
</EnumeratedDataType>
<EnumeratedDataType name="EventType" shortDescription="Identifies type of event message" >
<IntegerDataEncoding sizeInBits="16" encoding="unsigned" />
<EnumerationList>
<Enumeration label="DEBUG" value="1" shortDescription="Events that are intended only for debugging, not nominal operations" />
<Enumeration label="INFORMATION" value="2" shortDescription="Events that identify a state change or action that is not an error" />
<Enumeration label="ERROR" value="3" shortDescription="Events that identify an error but are not catastrophic (e.g. - bad command)" />
<Enumeration label="CRITICAL" value="4" shortDescription="Events that identify errors that are unrecoverable autonomously" />
</EnumerationList>
</EnumeratedDataType>
<EnumeratedDataType name="EventFilter" shortDescription="Identifies event filter schemes" >
<IntegerDataEncoding sizeInBits="8" encoding="unsigned" />
<EnumerationList>
<Enumeration label="BINARY" value="0" shortDescription="Binary event filter" />
</EnumerationList>
</EnumeratedDataType>
<EnumeratedDataType name="EventOutput" shortDescription="Identifies event output port" >
<IntegerDataEncoding sizeInBits="8" encoding="unsigned" />
<EnumerationList>
<Enumeration label="PORT1" value="1" shortDescription="Output Port 1" />
<Enumeration label="PORT2" value="2" shortDescription="Output Port 2" />
<Enumeration label="PORT3" value="3" shortDescription="Output Port 3" />
<Enumeration label="PORT4" value="4" shortDescription="Output Port 4" />
</EnumerationList>
</EnumeratedDataType>
<StringDataType name="EventMessage" length="${CFE_MISSION/EVS_MAX_MESSAGE_LENGTH}" shortDescription="Event Message Text" />
<ContainerDataType name="LogFileCmd_Payload" shortDescription="Write Event Log to File Command">
<LongDescription>
For command details, see #CFE_EVS_FILE_WRITE_LOG_DATA_CC
</LongDescription>
<EntryList>
<Entry name="LogFilename" type="BASE_TYPES/PathName" shortDescription="Filename where log data is to be written" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="AppDataCmd_Payload" shortDescription="Write Event Services Application Information to File Command">
<LongDescription>
For command details, see #CFE_EVS_FILE_WRITE_APP_DATA_CC
</LongDescription>
<EntryList>
<Entry name="AppDataFilename" type="BASE_TYPES/PathName" shortDescription="Filename where application data is to be written" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="SetLogMode_Payload" shortDescription="Set Log Mode Commands">
<LongDescription>
For command details, see #CFE_EVS_SET_LOG_MODE_CC
</LongDescription>
<EntryList>
<Entry name="LogMode" type="LogMode" shortDescription="Mode to use in the command" />
<PaddingEntry sizeInBits="8" shortDescription="Spare bytes for alignment"/>
</EntryList>
</ContainerDataType>
<ContainerDataType name="SetEventFormatMode_Payload" shortDescription="Set Event Format Commands">
<LongDescription>
For command details, see #CFE_EVS_SET_EVENT_FORMAT_MODE_CC
</LongDescription>
<EntryList>
<Entry name="MsgFormat" type="MsgFormat" shortDescription="Format to use in the command" />
<PaddingEntry sizeInBits="8" shortDescription="Spare bytes for alignment"/>
</EntryList>
</ContainerDataType>
<ContainerDataType name="BitMaskCmd_Payload" shortDescription="Enable/Disable Events or Ports Commands">
<LongDescription>
For command details, see #CFE_EVS_ENABLE_EVENT_TYPE_CC, #CFE_EVS_DISABLE_EVENT_TYPE_CC,
#CFE_EVS_ENABLE_PORTS_CC and/or #CFE_EVS_DISABLE_PORTS_CC
</LongDescription>
<EntryList>
<Entry name="BitMask" type="BASE_TYPES/uint8" shortDescription="BitMask to use in the command" />
<PaddingEntry sizeInBits="8" shortDescription="Spare bytes for alignment"/>
</EntryList>
</ContainerDataType>
<ContainerDataType name="AppNameCmd_Payload" shortDescription="Enable/Disable Application Events or Reset One or All Filter Counters">
<LongDescription>
For command details, see #CFE_EVS_ENABLE_APP_EVENTS_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC,
#CFE_EVS_RESET_APP_COUNTER_CC and/or #CFE_EVS_RESET_ALL_FILTERS_CC
</LongDescription>
<EntryList>
<Entry name="AppName" type="BASE_TYPES/ApiName" shortDescription="Application name to use in the command" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="AppNameEventIDCmd_Payload" shortDescription="Reset an Event Filter for an Application">
<LongDescription>
For command details, see #CFE_EVS_RESET_FILTER_CC
</LongDescription>
<EntryList>
<Entry name="AppName" type="BASE_TYPES/ApiName" shortDescription="Application name to use in the command" />
<Entry name="EventID" type="BASE_TYPES/uint16" shortDescription="Event ID to use in the command" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="AppNameBitMaskCmd_Payload" shortDescription="Enable/Disable an Event Type for an Application">
<LongDescription>
For command details, see #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC and/or #CFE_EVS_DISABLE_APP_EVENT_TYPE_CC
</LongDescription>
<EntryList>
<Entry name="AppName" type="BASE_TYPES/ApiName" shortDescription="Application name to use in the command" />
<Entry name="BitMask" type="BASE_TYPES/uint8" shortDescription="BitMask to use in the command" />
<PaddingEntry sizeInBits="8" shortDescription="Spare bytes for alignment"/>
</EntryList>
</ContainerDataType>
<ContainerDataType name="AppNameEventIDMaskCmd_Payload" shortDescription="Set, Add or Delete an Event Filter for an Application">
<LongDescription>
For command details, see #CFE_EVS_SET_FILTER_CC, #CFE_EVS_ADD_EVENT_FILTER_CC
and/or #CFE_EVS_DELETE_EVENT_FILTER_CC
</LongDescription>
<EntryList>
<Entry name="AppName" type="BASE_TYPES/ApiName" shortDescription="Application name to use in the command" />
<Entry name="EventID" type="BASE_TYPES/uint16" shortDescription="Event ID to use in the command" />
<Entry name="Mask" type="BASE_TYPES/uint16" shortDescription="Mask to use in the command" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="AppTlmData">
<EntryList>
<Entry name="AppID" type="CFE_ES/AppId" shortDescription="Numerical application identifier">
<LongDescription>
\cfetlmmnemonic \EVS_APPID
</LongDescription>
</Entry>
<Entry name="AppMessageSentCounter" type="BASE_TYPES/uint16" shortDescription="Application message sent counter">
<LongDescription>
\cfetlmmnemonic \EVS_APPMSGSENTC
</LongDescription>
</Entry>
<Entry name="AppEnableStatus" type="BASE_TYPES/uint8" shortDescription="Application event service enable status">
<LongDescription>
\cfetlmmnemonic \EVS_APPENASTAT
</LongDescription>
</Entry>
<Entry name="AppMessageSquelchedCounter" type="BASE_TYPES/uint8" shortDescription="Application event squelch count">
<LongDescription>
\cfetlmmnemonic \EVS_SQUELCHEDC
</LongDescription>
</Entry>
</EntryList>
</ContainerDataType>
<ArrayDataType name="AppTlmData_x_CFE_ES_MAX_APPLICATIONS" dataTypeRef="AppTlmData">
<DimensionList>
<Dimension size="${CFE_MISSION/ES_MAX_APPLICATIONS}" />
</DimensionList>
</ArrayDataType>
<ContainerDataType name="HousekeepingTlm_Payload" shortDescription="Event Services Housekeeping Telemetry Packet_Payload">
<EntryList>
<Entry name="CommandCounter" type="BASE_TYPES/uint8" shortDescription="EVS Command Counter">
<LongDescription>
\cfetlmmnemonic \EVS_CMDPC
</LongDescription>
</Entry>
<Entry name="CommandErrorCounter" type="BASE_TYPES/uint8" shortDescription="EVS Command Error Counter">
<LongDescription>
\cfetlmmnemonic \EVS_CMDEC
</LongDescription>
</Entry>
<Entry name="MessageFormatMode" type="MsgFormat" shortDescription="Event message format mode (short/long)">
<LongDescription>
\cfetlmmnemonic \EVS_MSGFMTMODE
</LongDescription>
</Entry>
<Entry name="MessageTruncCounter" type="BASE_TYPES/uint8" shortDescription="Event message truncation counter">
<LongDescription>
\cfetlmmnemonic \EVS_MSGTRUNC
</LongDescription>
</Entry>
<Entry name="UnregisteredAppCounter" type="BASE_TYPES/uint8" shortDescription="Unregistered application message send counter">
<LongDescription>
\cfetlmmnemonic \EVS_UNREGAPPC
</LongDescription>
</Entry>
<Entry name="OutputPort" type="BASE_TYPES/uint8" shortDescription="Output port mask">
<LongDescription>
\cfetlmmnemonic \EVS_OUTPUTPORT
</LongDescription>
</Entry>
<Entry name="LogFullFlag" type="BASE_TYPES/uint8" shortDescription="Local event log full flag">
<LongDescription>
\cfetlmmnemonic \EVS_LOGFULL
</LongDescription>
</Entry>
<Entry name="LogMode" type="LogMode" shortDescription="Local event logging mode (overwrite/discard)">
<LongDescription>
\cfetlmmnemonic \EVS_LOGMODE
</LongDescription>
</Entry>
<Entry name="MessageSendCounter" type="BASE_TYPES/uint16" shortDescription="Event message send counter">
<LongDescription>
\cfetlmmnemonic \EVS_MSGSENTC
</LongDescription>
</Entry>
<Entry name="LogOverflowCounter" type="BASE_TYPES/uint16" shortDescription="Local event log overflow counter">
<LongDescription>
\cfetlmmnemonic \EVS_LOGOVERFLOWC
</LongDescription>
</Entry>
<Entry name="LogEnabled" type="BASE_TYPES/uint8" shortDescription="Current event log enable/disable state">
<LongDescription>
\cfetlmmnemonic \EVS_LOGENABLED
</LongDescription>
</Entry>
<PaddingEntry sizeInBits="24" shortDescription="Spare bytes for alignment"/>
<Entry name="AppData" type="AppTlmData_x_CFE_ES_MAX_APPLICATIONS">
<LongDescription>
\cfetlmmnemonic \EVS_APP
</LongDescription>
</Entry>
</EntryList>
</ContainerDataType>
<ContainerDataType name="PacketID" shortDescription="Telemetry packet structures">
<EntryList>
<Entry name="AppName" type="BASE_TYPES/ApiName" shortDescription="Application name">
<LongDescription>
\cfetlmmnemonic \EVS_APPNAME
</LongDescription>
</Entry>
<Entry name="EventID" type="BASE_TYPES/uint16" shortDescription="Numerical event identifier">
<LongDescription>
\cfetlmmnemonic \EVS_EVENTID
</LongDescription>
</Entry>
<Entry name="EventType" type="BASE_TYPES/uint16" shortDescription="Numerical event type identifier">
<LongDescription>
\cfetlmmnemonic \EVS_EVENTTYPE
</LongDescription>
</Entry>
<Entry name="SpacecraftID" type="BASE_TYPES/uint32" shortDescription="Spacecraft identifier">
<LongDescription>
\cfetlmmnemonic \EVS_SCID
</LongDescription>
</Entry>
<Entry name="ProcessorID" type="BASE_TYPES/uint32" shortDescription="Numeric processor identifier">
<LongDescription>
\cfetlmmnemonic \EVS_PROCESSORID
</LongDescription>
</Entry>
</EntryList>
</ContainerDataType>
<ContainerDataType name="LongEventTlm_Payload" shortDescription="Event Message Telemetry Payload Long Format">
<EntryList>
<Entry name="PacketID" type="PacketID" shortDescription="Event packet information" />
<Entry name="Message" type="EventMessage" shortDescription="Event message string">
<LongDescription>
\cfetlmmnemonic \EVS_EVENT
</LongDescription>
</Entry>
</EntryList>
</ContainerDataType>
<ContainerDataType name="ShortEventTlm_Payload" shortDescription="Event Message Telemetry Payload Short Format">
<EntryList>
<Entry name="PacketID" type="PacketID" shortDescription="Event packet information" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="CommandBase" baseType="CFE_HDR/CommandHeader" shortDescription="Base type for all Event Services commands">
</ContainerDataType>
<ContainerDataType name="SendHkCmd" baseType="CFE_HDR/CommandHeader" shortDescription="Send Housekeeping Command" />
<ContainerDataType name="HousekeepingTlm" baseType="CFE_HDR/TelemetryHeader" shortDescription="Event Services Housekeeping Telemetry">
<EntryList>
<Entry type="HousekeepingTlm_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="LongEventTlm" baseType="CFE_HDR/TelemetryHeader" shortDescription="Event Services Event Message">
<EntryList>
<Entry type="LongEventTlm_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="ShortEventTlm" baseType="CFE_HDR/TelemetryHeader" shortDescription="Event Services Event Message">
<EntryList>
<Entry type="ShortEventTlm_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="NoopCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Event Services No-Op
\par Description
This command performs no other function than to increment the
command execution counter. The command may be used to verify
general aliveness of the Event Services task.
\cfecmdmnemonic \EVS_NOOP
\par Command Structure
#CFE_TBL_NoArgsCmd_t
\par Command Verification
Successful execution of this command may be verified with the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will increment
- The #CFE_EVS_NOOP_EID informational event message will be generated
\par Error Conditions
There are no error conditions for this command. If the Event
Services receives the command, the event is sent (although it
may be filtered by EVS itself) and the counter is incremented
unconditionally.
\par Criticality
None
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="0" />
</ConstraintSet>
</ContainerDataType>
<ContainerDataType name="ResetCountersCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Event Services Reset Counters
\par Description
This command resets the following counters within the Event
Services housekeeping telemetry:
- Command Execution Counter (\EVS_CMDPC)
- Command Error Counter (\EVS_CMDEC)
\cfecmdmnemonic \EVS_RESETCTRS
\par Command Structure
#CFE_TBL_NoArgsCmd_t
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will
increment
- The #CFE_EVS_RSTCNT_EID debug event message will be
generated
\par Error Conditions
There are no error conditions for this command. If the Event
Services receives the command, the event is sent (although it
may be filtered by EVS) and the counter is incremented
unconditionally.
\par Criticality
This command is not inherently dangerous. However, it is
possible for ground systems and on-board safing procedures
to be designed such that they react to changes in the counter
values that are reset by this command.
\sa #CFE_EVS_RESET_APP_COUNTER_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="1" />
</ConstraintSet>
</ContainerDataType>
<ContainerDataType name="EnableEventTypeCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Enable Event Type
\par Description
This command enables the command specified Event Type allowing event
messages of this type to be sent through Event Service. An Event Type
is defined to be a classification of an Event Message such as debug,
informational, error and critical. This command is a global enable of a
particular event type, it applies to all applications.
\cfecmdmnemonic \EVS_ENAEVENTTYPE
\par Command Structure
#CFE_EVS_BitMaskCmd_t
The following bit positions apply to structure member named 'BitMask'.
Bit 0 - Debug
Bit 1 - Informational
Bit 2 - Error
Bit 3 - Critical
A one in a bit position means the event type will be enabled (or unfiltered).
A zero in a bit position means the filtering state is unchanged.
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will
increment
- The generation of #CFE_EVS_ENAEVTTYPE_EID debug message
\par Error Conditions
This command may fail for the following reason(s):
Invalid Event Type selection
Evidence of failure may be found in the following telemetry:
- \b \c \EVS_CMDEC - command error counter will increment
- An Error specific event message
\par Criticality
Enabling an event type is not particularly hazardous, as the result may
be turning on necessary event messages and communication to the ground
system. However, inappropriately enabling an event type could result
in flooding of the system.
\sa #CFE_EVS_DISABLE_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC,
#CFE_EVS_DISABLE_APP_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENTS_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="2" />
</ConstraintSet>
<EntryList>
<Entry type="BitMaskCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="DisableEventTypeCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Disable Event Type
\par Description
This command disables the command specified Event Type preventing event
messages of this type to be sent through Event Service. An Event Type
is defined to be a classification of an Event Message such as debug,
informational, error and critical. This command is a global disable of a
particular event type, it applies to all applications.
\cfecmdmnemonic \EVS_DISEVENTTYPE
\par Command Structure
#CFE_EVS_BitMaskCmd_t
The following bit positions apply to structure member named 'BitMask'.
Bit 0 - Debug
Bit 1 - Informational
Bit 2 - Error
Bit 3 - Critical
A one in a bit position means the event type will be disabled (or filtered).
A zero in a bit position means the filtering state is unchanged.
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will
increment
- The generation of #CFE_EVS_DISEVTTYPE_EID debug message
\par Error Conditions
This command may fail for the following reason(s):
- Invalid Event Type selection
Evidence of failure may be found in the following telemetry:
- \b \c \EVS_CMDEC - command error counter will increment
- An Error specific event message
\par Criticality
Disabling an event type is not particularly hazardous, as the result
may be shutting off unnecessary event messages and possible event
flooding of the system. However, inappropriately disabling an event
type could result in a loss of critical information and missed
behavior for the ground system.
\sa #CFE_EVS_ENABLE_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC,
#CFE_EVS_DISABLE_APP_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENTS_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="3" />
</ConstraintSet>
<EntryList>
<Entry type="BitMaskCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="SetEventFormatModeCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Set Event Format Mode
\par Description
This command sets the event format mode to the command specified value.
The event format mode may be either short or long. A short event format
detaches the Event Data from the event message and only includes the
following information in the event packet: Processor ID, Application ID,
Event ID, and Event Type. Refer to section 5.3.3.4 for a description of
the Event Service event packet contents. Event Data is defined to be data
describing an Event that is supplied to the cFE Event Service. ASCII text
strings are used as the primary format for Event Data because heritage
ground systems use string compares as the basis for their automated alert
systems. Two systems, ANSR and SERS were looked at for interface
definitions. The short event format is used to accommodate experiences
with limited telemetry bandwidth. The long event format includes all event
information included within the short format along with the Event Data.
\cfecmdmnemonic \EVS_SETEVTFMT
\par Command Structure
#CFE_EVS_ModeCmd_t
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will
increment
- The generation of #CFE_EVS_SETEVTFMTMOD_EID debug message
\par Error Conditions
This command may fail for the following reason(s):
Invalid SB message (command) length
Invalid MODE selection
Evidence of failure may be found in the following telemetry:
- \b \c \EVS_CMDEC - command error counter will increment
- An Error specific event message
\par Criticality
Setting the event format mode is not particularly hazardous, as the
result may be saving necessary bandwidth. However, inappropriately
setting the event format mode could result in a loss of information
and missed behavior for the ground system
\sa
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="4" />
</ConstraintSet>
<EntryList>
<Entry type="SetEventFormatMode_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="EnableAppEventTypeCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Enable Application Event Type
\par Description
This command enables the command specified event type for the command
specified application, allowing the application to send event messages
of the command specified event type through Event Service. An Event
Type is defined to be a classification of an Event Message such as
debug, informational, critical, and error.
Note: In order for this command to take effect, applications must be
registered for Event Service.
\cfecmdmnemonic \EVS_ENAAPPEVTTYPE
\par Command Structure
#CFE_EVS_AppNameBitMaskCmd_t
The following bit positions apply to structure member named 'BitMask'.
Bit 0 - Debug
Bit 1 - Informational
Bit 2 - Error
Bit 3 - Critical
A one in a bit position means the event type will be enabled (or
unfiltered) for the specified application.
A zero in a bit position means the filtering state is unchanged for
the specified application.
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will
increment
- The generation of #CFE_EVS_ENAAPPEVTTYPE_EID debug event message
\par Error Conditions
This command may fail for the following reason(s):
- Invalid Event Type Selection
Evidence of failure may be found in the following telemetry:
- \b \c \EVS_CMDEC - command error counter will increment
- An Error specific event message
\par Criticality
Enabling an application's event type is not particularly hazardous, as
the result may be turning on necessary event messages and
communication to the ground system. However, inappropriately enabling
an application's event type could result in flooding of the ground system.
\sa #CFE_EVS_ENABLE_EVENT_TYPE_CC, #CFE_EVS_DISABLE_EVENT_TYPE_CC,
#CFE_EVS_DISABLE_APP_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENTS_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="5" />
</ConstraintSet>
<EntryList>
<Entry type="AppNameBitMaskCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="DisableAppEventTypeCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Disable Application Event Type
\par Description
This command disables the command specified event type for the command
specified application, preventing the application from sending event
messages of the command specified event type through Event Service.
An Event Type is defined to be a classification of an Event Message such
as debug, informational, critical, and error. Note: In order for this
command to take effect, applications must be registered for Event Service.
\cfecmdmnemonic \EVS_DISAPPEVTTYPE
\par Command Structure
#CFE_EVS_AppNameBitMaskCmd_t
The following bit positions apply to structure member named 'BitMask'.
Bit 0 - Debug
Bit 1 - Informational
Bit 2 - Error
Bit 3 - Critical
A one in a bit position means the event type will be disabled (or
filtered) for the specified application.
A zero in a bit position means the filtering state is unchanged for
the specified application.
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will increment
- The generation of #CFE_EVS_DISAPPENTTYPE_EID debug event message
- The clearing of the Active Flag in \link #CFE_EVS_AppDataFile_t::ActiveFlag \endlink The Active Flag in EVS App Data File
\par Error Conditions
This command may fail for the following reason(s):
- Invalid Event Type Selection
Evidence of failure may be found in the following telemetry:
- \b \c \EVS_CMDEC - command error counter will increment
- An Error specific event message
\par Criticality
Disabling an application's event type is not particularly hazardous,
as the result may be shutting off unnecessary event messages and
possible event flooding of the system. However, inappropriately
disabling an application's event type could result in a loss of critical
information and missed behavior for the ground system.
\sa #CFE_EVS_ENABLE_EVENT_TYPE_CC, #CFE_EVS_DISABLE_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC,
#CFE_EVS_ENABLE_APP_EVENTS_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="6" />
</ConstraintSet>
<EntryList>
<Entry type="AppNameBitMaskCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="EnableAppEventsCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Enable Event Services for an Application
\par Description
This command enables the command specified application to send events
through the Event Service. Note: In order for this command to take
effect, applications must be registered for Event Service.
\cfecmdmnemonic \EVS_ENAAPPEVGEN
\par Command Structure
#CFE_EVS_AppNameCmd_t
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will
increment
- The generation of #CFE_EVS_ENAAPPEVT_EID debug event message
- The setting of the Active Flag in \link #CFE_EVS_AppDataFile_t::ActiveFlag \endlink The Active Flag in EVS App Data File
\par Error Conditions
This command may fail for the following reason(s):
- Invalid SB message (command) length
- Application selected is not registered to receive Event Service
- Application ID is out of range
Evidence of failure may be found in the following telemetry:
- \b \c \EVS_CMDEC - command error counter will increment
- An Error specific event message
\par Criticality
Enabling an application's events is not particularly hazardous,
as the result may be turning on necessary event messages and
communication to the ground system. However, inappropriately enabling
an application's events could result in flooding of the ground system.
\sa #CFE_EVS_ENABLE_EVENT_TYPE_CC, #CFE_EVS_DISABLE_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC,
#CFE_EVS_DISABLE_APP_EVENT_TYPE_CC, #CFE_EVS_DISABLE_APP_EVENTS_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="7" />
</ConstraintSet>
<EntryList>
<Entry type="AppNameCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="DisableAppEventsCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Disable Event Services for an Application
\par Description
This command disables the command specified application from sending
events through Event Service. Note: In order for this command to take
effect, applications must be registered for Event Service.
\cfecmdmnemonic \EVS_DISAPPEVGEN
\par Command Structure
#CFE_EVS_AppNameCmd_t
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will
increment
- The generation of #CFE_EVS_DISAPPEVT_EID debug event message
\par Error Conditions
This command may fail for the following reason(s):
- Invalid SB message (command) length
- Application selected is not registered to receive Event Service
- Application ID is out of range
Evidence of failure may be found in the following telemetry:
- \b \c \EVS_CMDEC - command error counter will increment
- An Error specific event message
\par Criticality
Disabling an application's events is not particularly hazardous, as the
result may be shutting off unnecessary event messages and possible event
flooding of the system. However, inappropriately disabling an
application's events could result in a loss of critical information and
missed behavior for the ground system.
\sa #CFE_EVS_ENABLE_EVENT_TYPE_CC, #CFE_EVS_DISABLE_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENT_TYPE_CC,
#CFE_EVS_DISABLE_APP_EVENT_TYPE_CC, #CFE_EVS_ENABLE_APP_EVENTS_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="8" />
</ConstraintSet>
<EntryList>
<Entry type="AppNameCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="ResetAppCounterCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Reset Application Event Counters
\par Description
This command sets the command specified application's event counter to zero.
Note: In order for this command to take effect, applications must be registered
for Event Service.
\cfecmdmnemonic \EVS_RSTAPPCTRS
\par Command Structure
#CFE_EVS_AppNameCmd_t
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will increment
- The generation of #CFE_EVS_RSTEVTCNT_EID debug event message
\par Error Conditions
This command may fail for the following reason(s):
- Invalid SB message (command) length
- Application selected is not registered to receive Event Service
- Application ID is out of range
Evidence of failure may be found in the following telemetry:
- \b \c \EVS_CMDEC - command error counter will increment
- An Error specific event message
\par Criticality
This command is not inherently dangerous. However, it is possible for
ground systems and on-board safing procedures to be designed such that
they react to changes in the counter value that is reset by this command.
\sa #CFE_EVS_RESET_COUNTERS_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="9" />
</ConstraintSet>
<EntryList>
<Entry type="AppNameCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="SetFilterCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Set Application Event Filter
\par Description
This command sets the command specified application's event filter mask
to the command specified value for the command specified event. Note:
In order for this command to take effect, applications must be
registered for Event Service.
\cfecmdmnemonic \EVS_SETBINFLTRMASK
\par Command Structure
#CFE_EVS_AppNameEventIDMaskCmd_t
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will increment
- The generation of #CFE_EVS_SETFILTERMSK_EID debug event message
\par Error Conditions
This command may fail for the following reason(s):
- Invalid SB message (command) length
- Application selected is not registered to receive Event Service
- Application ID is out of range
Evidence of failure may be found in the following telemetry:
- \b \c \EVS_CMDEC - command error counter will increment
- An Error specific event message
\par Criticality
Setting an application's event filter mask is not particularly hazardous,
as the result may be shutting off unnecessary event messages and possible
event flooding of the system. However, inappropriately setting an
application's event filter mask could result in a loss of critical
information and missed behavior for the ground system or flooding of the
ground system.
\sa #CFE_EVS_RESET_FILTER_CC, #CFE_EVS_RESET_ALL_FILTERS_CC, #CFE_EVS_ADD_EVENT_FILTER_CC, #CFE_EVS_DELETE_EVENT_FILTER_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="10" />
</ConstraintSet>
<EntryList>
<Entry type="AppNameEventIDMaskCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="EnablePortsCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Enable Event Services Output Ports
\par Description
This command enables the command specified port to output event messages
\cfecmdmnemonic \EVS_ENAPORT
\par Command Structure
#CFE_EVS_BitMaskCmd_t
The following bit positions apply to structure member named 'BitMask'.
Bit 0 - Port 1
Bit 1 - Port 2
Bit 2 - Port 3
Bit 3 - Port 4
A one in a bit position means the port will be enabled.
A zero in a bit position means the port state is unchanged.
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will increment
- The generation of #CFE_EVS_ENAPORT_EID debug event message
\par Error Conditions
This command may fail for the following reason(s):
- Invalid SB message (command) length
- Invalid PORT selection
Evidence of failure may be found in the following telemetry:
- \b \c \EVS_CMDEC - command error counter will increment
- An Error specific event message
\par Criticality
None.
\sa #CFE_EVS_DISABLE_PORTS_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="11" />
</ConstraintSet>
<EntryList>
<Entry type="BitMaskCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="DisablePortsCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Disable Event Services Output Ports
\par Description
This command disables the specified port from outputting event messages.
\cfecmdmnemonic \EVS_DISPORT
\par Command Structure
#CFE_EVS_BitMaskCmd_t
The following bit positions apply to structure member named 'BitMask'.
Bit 0 - Port 1
Bit 1 - Port 2
Bit 2 - Port 3
Bit 3 - Port 4
A one in a bit position means the port will be disabled.
A zero in a bit position means the port state is unchanged.
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will
increment
- The generation of #CFE_EVS_DISPORT_EID debug event message
\par Error Conditions
This command may fail for the following reason(s):
- Invalid SB message (command) length
- Invalid PORT selection
Evidence of failure may be found in the following telemetry:
- \b \c \EVS_CMDEC - command error counter will increment
- An Error specific event message
\par Criticality
None.
\sa #CFE_EVS_ENABLE_PORTS_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="12" />
</ConstraintSet>
<EntryList>
<Entry type="BitMaskCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="ResetFilterCmd" baseType="CommandBase">
<LongDescription>
\cfeevscmd Reset an Event Filter for an Application
\par Description
This command resets the command specified application's event filter for
the command specified event ID. Note: In order for this command to take
effect, applications must be registered for Event Service.
\cfecmdmnemonic \EVS_RSTBINFLTRCTR
\par Command Structure
#CFE_EVS_AppNameEventIDCmd_t
\par Command Verification
Successful execution of this command may be verified with
the following telemetry:
- \b \c \EVS_CMDPC - command execution counter will increment
- The generation of #CFE_EVS_RSTFILTER_EID debug event message
\par Error Conditions
This command may fail for the following reason(s):
- Invalid SB message (command) length
- Application selected is not registered to receive Event Service
- Application ID is out of range
Evidence of failure may be found in the following telemetry:
- \b \c \EVS_CMDEC - command error counter will increment
- An Error specific event message
\par Criticality
None.
\sa #CFE_EVS_SET_FILTER_CC, #CFE_EVS_RESET_ALL_FILTERS_CC, #CFE_EVS_ADD_EVENT_FILTER_CC, #CFE_EVS_DELETE_EVENT_FILTER_CC
</LongDescription>
<ConstraintSet>
<ValueConstraint entry="Sec.FunctionCode" value="13" />
</ConstraintSet>
<EntryList>
<Entry type="AppNameEventIDCmd_Payload" name="Payload" />
</EntryList>
</ContainerDataType>
<ContainerDataType name="ResetAllFiltersCmd" baseType="CommandBase">
<LongDescription>