This repository has been archived by the owner on May 8, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathrvc-spec.yaml
3472 lines (3263 loc) · 64.2 KB
/
rvc-spec.yaml
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
---
# This file is versioned. Any changes here, even as small as changing
# a name from lower case to upper case, can have an impact on tools
# that have been written to use the mqtt output generated from this
# spec file.
API_VERSION: 1
17F00:
name: GENERAL_RESET
parameters:
- byte: 0
bit: 0-1
name: reboot
type: bit
values:
00: no action
01: Reboot
- byte: 0
bit: 2-3
name: clear faults
type: bit
values:
00: no action
01: clear faults
- byte: 0
bit: 4-5
name: reset to default settings
type: bit
values:
00: no action
01: reset to default settings
- byte: 0
bit: 6-7
name: reset statistics
type: bit
values:
00: no action
01: reset statistics
17E00:
name: TERMINAL
parameters:
- byte: 0-7
type: ascii
1FED8:
name: GENERIC_CONFIGURATION_STATUS
parameters:
- byte: 0
name: manufacturer code (LSB)
- byte: 1
bit: 0-2
name: manufacturer code (MS bits)
- byte: 1
bit: 3-7
name: function instance
- byte: 2
name: function
- byte: 3
name: firmware revision
- byte: 4
name: configuration type (LSB)
- byte: 5
name: configuration type
- byte: 6
name: configuration type (MSB)
- byte: 7
name: configuration revision
1FFFF:
name: DATE_TIME_STATUS
parameters:
- byte: 0
name: year
type: uint8
unit: year
- byte: 1
name: month
type: uint8
- byte: 2
name: date
type: uint8
- byte: 3
name: day of week
type: uint8
values:
1: Sunday
2: Monday
3: Tuesday
4: Wednesday
5: Thursday
6: Friday
7: Saturday
- byte: 4
name: hour
type: uint8
- byte: 5
name: minute
type: uint8
- byte: 6
name: second
type: uint8
- byte: 7
name: time zone
type: uint8
values:
0: Greenwich Mean Time
4: Eastern Daylight Time
5: Eastern Standard Time
7: Pacific Daylight Time
8: Pacific Standard Time
22: Central European Summer Time
1FFFE:
name: SET_DATE_TIME_COMMAND
alias: 1FFFF
1FFFD:
name: DC_SOURCE_STATUS_1
parameters:
- byte: 0
name: instance
type: uint8
values:
0: invalid
1: main house battery bank
2: chassis start battery
3: secondary house battery bank
- byte: 1
name: device priority
type: uint8
values:
120: battery soc device
100: inverter charger
80: charger
60: inverter
40: voltmeter ammeter
20: voltmeter
- byte: 2-3
name: dc voltage
type: uint16
unit: V
- byte: 4-7
name: dc current
type: uint32
unit: A
1FFFC:
name: DC_SOURCE_STATUS_2
parameters:
- byte: 0
name: instance
type: uint8
values:
0: invalid
1: main house battery bank
2: chassis start battery
3: secondary house battery bank
- byte: 1
name: device priority
type: uint8
values:
120: battery soc device
100: inverter Charger
80: charger
60: inverter
40: voltmeter ammeter
20: voltmeter
- byte: 2-3
name: source temperature
type: uint16
unit: Deg C
- byte: 4
name: state of charge
type: uint8
unit: pct
- byte: 5-6
name: time remaining
type: uint16
unit: min
1FFFB:
name: DC_SOURCE_STATUS_3
parameters:
- byte: 0
name: instance
type: uint8
values:
0: invalid
1: main house battery bank
2: chassis start battery
3: secondary house battery bank
- byte: 1
name: device priority
type: uint8
values:
120: battery soc device
100: inverter charger
80: charger
60: inverter
40: voltmeter ammeter
20: voltmeter
- byte: 2
name: state of health
type: uint8
unit: pct
- byte: 3-4
name: capacity remaining
type: uint16
unit: Ah
- byte: 5
name: relative capacity
type: uint8
unit: pct
- byte: 6-7
name: ac rms ripple
type: uint16
unit: mV
1FEC9:
name: DC_SOURCE_STATUS_4
parameters:
- byte: 0
name: instance
type: uint8
values:
0: invalid
1: main house battery bank
2: chassis start battery
3: secondary house battery bank
- byte: 1
name: device priority
type: uint8
values:
120: battery soc device
100: inverter charger
80: charger
60: inverter
40: voltmeter ammeter
20: voltmeter
- byte: 2
name: desired charge state
type: uint8
values:
0: undefined
1: do not charge
2: bulk
3: absorbtion
4: overcharge
5: equalize
6: float
7: constant voltage current
- byte: 3-4
name: desired dc voltage
type: uint16
unit: V
- byte: 5-6
name: desired dc current
type: uint16
unit: A
- byte: 7
bit: 0-3
name: battery type
type: uint4
values:
0: flooded
1: gel
2: agm
3: lithium iron phosphate
1FEC8:
name: DC_SOURCE_STATUS_5
parameters:
- byte: 0
name: instance
type: uint8
values:
0: invalid
1: main house battery bank
2: chassis start battery
3: secondary house battery bank
- byte: 1
name: device priority
type: uint8
values:
120: battery soc device
100: inverter charger
80: charger
60: inverter
40: voltmeter ammeter
20: voltmeter
- byte: 2-5
name: hp dc voltage
type: uint32
unit: V
- byte: 6-7
name: dc voltage rate of change
type: uint16
unit: mV/s
1FEC7:
name: DC_SOURCE_STATUS_6
parameters:
- byte: 0
name: instance
type: uint8
values:
0: invalid
1: main house battery bank
2: chassis start battery
3: secondary house battery bank
- byte: 1
name: device priority
type: uint8
values:
120: battery soc device
100: inverter charger
80: charger
60: inverter
40: voltmeter ammeter
20: voltmeter
- byte: 2
bit: 0-1
name: high voltage limit status
type: bit
values:
00: not reached
01: limit reached
- byte: 2
bit: 2-3
name: high voltage disconnect status
type: bit
values:
00: connected
01: charge bus disconnected
- byte: 2
bit: 4-5
name: low voltage limit status
type: bit
values:
00: not reached
01: limit reached
- byte: 2
bit: 6-7
name: low voltage disconnect status
type: bit
values:
00: connected
01: charge bus disconnected
10FFD:
name: DC_SOURCE_STATUS_SPYDER
alias: 1FFFD
comment: Spyder sometimes uses this off-spec DGN to report house battery voltage in case the Magnum inverter uses the primary DGN.
1FFFA:
name: COMMUNICATION_STATUS_1
parameters:
- byte: 0-3
name: timer count
type: uint32
unit: ms
- byte: 4-5
name: receive error count
type: uint16
- byte: 6-7
name: transmit error count
type: uint16
1FFF9:
name: COMMUNICATION_STATUS_2
parameters:
- byte: 0-3
name: transmitted frames count
type: uint32
- byte: 4-7
name: received frames count
type: uint32
1FFF8:
name: COMMUNICATION_STATUS_3
parameters:
- byte: 0-1
name: bus-off error count
type: uint16
- byte: 2-3
name: receive frames dropped count
type: uint16
- byte: 4-5
name: transmit frames dropped count
type: uint16
1FFF7:
name: WATERHEATER_STATUS
parameters:
- byte: 0
name: instance
type: uint8
- byte: 1
name: operating modes
type: uint8
values:
0: off
1: combustion
2: electric
3: gas electric
4: automatic
5: test combustion
6: test electric
- byte: 2-3
name: set point temperature
type: uint16
unit: Deg C
- byte: 4-5
name: water temperature
type: uint16
unit: Deg C
- byte: 6
bit: 0-1
name: thermostat status
type: bit
values:
00: set point met
01: set point not met
- byte: 6
bit: 2-3
name: burner status
type: bit
values:
00: off
01: ac element is active
- byte: 6
bit: 4-5
name: ac element status
type: bit
values:
00: no fault
01: open neutral fault detected
- byte: 6
bit: 6-7
name: high temperature limit switch status
type: bit
values:
00: limit switch not tripped
01: limit switch tripped
- byte: 7
bit: 0-1
name: failure to ignite status
type: bit
values:
00: no failure
01: failed to ignite
- byte: 7
bit: 2-3
name: ac power failure status
type: bit
values:
00: ac power present
01: ac power not present
- byte: 7
bit: 4-5
name: dc power failure status
type: bit
values:
00: dc power present
01: dc power not present
1FFF6:
name: WATERHEATER_COMMAND
alias: 1FFF7
1FFF5:
name: GAS_SENSOR_STATUS
parameters:
- byte: 0
name: instance
type: uint8
- byte: 1
name: type
type: uint8
values:
1: co
2: lp gas
3: smoke
- byte: 2-3
name: ppm
type: uint16
unit: ppm
- byte: 4
bit: 0-1
name: alarm
unit: bit
values:
00: no alarm
01: alarm
- byte: 4
bit: 2-3
name: warning
unit: bit
values:
00: no warning
01: warning
- byte: 4
bit: 4-5
name: dc supply failure
unit: bit
values:
00: no failure
01: failure
- byte: 4
bit: 6-7
name: sensor failure
unit: bit
values:
00: no failure
01: failure
1FFF4:
name: CHASSIS_MOBILITY_STATUS
parameters:
- byte: 0-1
name: engine rpms
type: uint16
unit: rpm
- byte: 2-3
name: vehicle speed
type: uint16
unit: kph
- byte: 4
bit: 0-1
name: park brake status
type: bit
values:
00: park brake released
01: park brake engaged
- byte: 4
bit: 2-3
name: transmission lock status
type: bit
values:
00: transmission not locked
01: transmission locked
- byte: 4
bit: 4-5
name: engine lock status
type: bit
values:
00: engine free to start
01: engine locked
- byte: 5
bit: 0-1
name: ignition switch status
type: bit
values:
00: off
01: on
- byte: 5
bit: 2-4
name: accessory switch status
type: bit
values:
00: off
01: on
- byte: 6
name: transmission current gear
type: byte
values:
124: reverse 1
125: neutral
126: forward 1
127: forward 2
128: forward 3
129: forward 4
130: forward 5
131: forward 6
132: forward 7
251: park
- byte: 7
name: transmission gear selected
type: byte
values:
124: reverse 1
125: neutral
126: forward 1
127: forward 2
128: forward 3
129: forward 4
130: forward 5
131: forward 6
132: forward 7
251: park
1FFF3:
name: CHASSIS_MOBILITY_COMMAND
parameters:
- byte: 0
bit: 0-1
name: park brake command
type: bit
values:
00: please release chassis
01: please immobilize chassis
10: error
11: do not care about status
- byte: 0
bit: 2-3
name: park brake user override
type: bit
values:
00: normal priority
01: override
10: error
11: na
- byte: 1
bit: 0-1
name: transmission command
type: bit
values:
00: please release transmission
01: please lock transmission
10: error
11: do not care about status
- byte: 1
bit: 2-3
name: transmission lock user override
type: bit
values:
00: normal priority
01: override
10: error
11: na
- byte: 2
bit: 0-1
name: engine lock command
type: bit
values:
00: please release engine
01: please lock engine
10: error
11: do not care about status
- byte: 2
bit: 2-3
name: engine lock user override
type: bit
values:
00: normal priority
01: override
10: error
11: na
1FFF2:
name: AAS_CONFIG_STATUS
parameters:
- byte: 0
name: left front sensor mode
type: uint8
unit: Pct
- byte: 1
name: right front sensor mode
type: uint8
unit: Pct
- byte: 2
name: right rear sensor mode
type: uint8
unit: Pct
- byte: 3
name: left rear sensor mode
type: uint8
unit: Pct
- byte: 4
name: height correction threshold time
type: uint8
unit: min
- byte: 5
name: solenoid on time
type: uint8
unit: min
1FFF1:
name: AAS_COMMAND
alias: 1FFF2
1FFF0:
name: AAS_STATUS
parameters:
- byte: 0
bit: 0-1
name: aas operating status
type: bit
values:
00: off
01: on
- byte: 0
bit: 2-5
name: aas mode
type: uint4
values:
0000: normal
0001: fly mode
0010: reset
1110: error
1111: na
- byte: 1
name: left front sensor mode
type: uint8
unit: Pct
- byte: 2
name: right front sensor mode
type: uint8
unit: Pct
- byte: 3
name: right rear sensor mode
type: uint8
unit: Pct
- byte: 4
name: left rear sensor mode
type: uint8
unit: Pct
- byte: 5
bit: 0-1
name: tag axle position
type: bit
values:
00: down
01: up
1FFEF:
name: AAS_SENSOR_STATUS
parameters:
- byte: 0
bit: 0-1
name: left front sensor status low ride
type: uint8
values:
0: under set point
1: over set point
- byte: 0
bit: 2-3
name: left front sensor status medium ride
type: uint8
values:
0: under set point
1: over set point
- byte: 0
bit: 4-5
name: left front sensor status high ride
type: uint8
values:
0: under set point
1: over set point
- byte: 0
bit: 6-7
name: left front sensor transition
type: uint8
values:
0: no transition
1: transition was made
- byte: 1
bit: 0-1
name: left front quadrature encoder status channel A
type: uint8
- byte: 1
bit: 2-3
name: left front quadrature encoder status channel B
type: uint8
- byte: 2
bit: 0-1
name: right front sensor status low ride
type: uint8
values:
0: under set point
1: over set point
- byte: 2
bit: 2-3
name: right front sensor status medium ride
type: uint8
values:
0: under set point
1: over set point
- byte: 2
bit: 4-5
name: right front sensor status high ride
type: uint8
values:
0: under set point
1: over set point
- byte: 2
bit: 6-7
name: right front sensor transition
type: uint8
values:
0: no transition
1: transition was made
- byte: 3
bit: 0-1
name: right front quadrature encoder status channel A
type: uint8
- byte: 3
bit: 2-3
name: right front quadrature encoder status channel B
type: uint8
- byte: 3
bit: 4-5
name: steering sensor quadrature encoder status channel A
type: uint8
- byte: 3
bit: 6-7
name: steering sensor quadrature encoder status channel B
type: uint8
- byte: 4
bit: 0-1
name: left rear sensor status low ride
type: uint8
values:
0: under set point
1: over set point
- byte: 4
bit: 2-3
name: left rear sensor status medium ride
type: uint8
values:
0: under set point
1: over set point
- byte: 4
bit: 4-5
name: left rear sensor status high ride
type: uint8
values:
0: under set point
1: over set point
- byte: 4
bit: 6-7
name: left rear sensor transition
type: uint8
values:
0: no transition
1: transition was made
- byte: 5
bit: 0-1
name: left rear quadrature encoder status channel A
type: uint8
- byte: 5
bit: 2-3
name: left rear quadrature encoder status channel B
type: uint8
- byte: 6
bit: 0-1
name: right rear sensor status low ride
type: uint8
values:
0: under set point
1: over set point
- byte: 6
bit: 2-3
name: right rear sensor status medium ride
type: uint8
values:
0: under set point
1: over set point
- byte: 6
bit: 4-5
name: right rear sensor status high ride
type: uint8
values:
0: under set point
1: over set point
- byte: 6
bit: 6-7
name: right rear sensor transition
type: uint8
values:
0: no transition
1: transition was made
- byte: 7
bit: 0-1
name: right rear quadrature encoder status channel A
type: uint8
- byte: 7
bit: 2-3
name: right rear quadrature encoder status channel B
type: uint8
1FED1:
name: SUSPENSION_AIR_PRESSURE_STATUS
parameters:
- byte: 0
name: suspension system supply pressure
type: uint8
- byte: 1
name: steer axle left air spring
type: uint8
- byte: 2
name: steer axle right air spring
type: uint8
- byte: 3
name: drive axle left air spring
type: uint8
- byte: 4
name: drive axle right air spring
type: uint8
- byte: 5
name: tag axle left air spring
type: uint8
- byte: 6
name: tag axle left right spring
type: uint8
1FFEE:
name: LEVELING_CONTROL_COMMAND
1FFED:
name: LEVELING_CONTROL_STATUS
1FFEC:
name: LEVELING_JACK_STATUS
1FFEB:
name: LEVELING_SENSOR_STATUS
1FFEA:
name: HYDRAULIC_PUMP_STATUS
1FEBC:
name: HYDRAULIC_PUMP_COMMAND
1FFE9:
name: LEVELING_AIR_STATUS
1FFE8:
name: SLIDE_STATUS
1FFE7:
name: SLIDE_COMMAND
1FFE6:
name: SLIDE_SENSOR_STATUS
1FFE5:
name: SLIDE_MOTOR_STATUS
1FFE4:
name: FURNACE_STATUS
1FFE3:
name: FURNACE_COMMAND
1FFE2:
name: THERMOSTAT_STATUS_1
parameters:
- byte: 0
name: instance
type: uint8
comment: Corresponds to "Zones" in user terminology.
- byte: 1
bit: 0-3
name: operating mode
type: bit4
values:
0000: off
0001: cool
0010: heat
0011: auto
0100: fan only
- byte: 1
bit: 4-5
name: fan mode
type: bit
values:
00: auto
01: on
comment: This forces the fan to be on all the time, but allows heat and cool to turn on and off according to the Operating Mode.
- byte: 1
bit: 6-7
name: schedule mode
type: bit
values:
00: disabled
01: enabled
comment: If enabled, the set point will change according to programmed scheduled.
- byte: 2
name: fan speed
type: uint8
unit: Pct
- byte: 3-4
name: setpoint temp heat
type: uint16
unit: Deg C
- byte: 5-6
name: setpoint temp cool
type: uint16
unit: Deg C
1FEFA:
name: THERMOSTAT_STATUS_2
parameters:
- byte: 0
name: instance
type: uint8
comment: Corresponds to "Zones" in user terminology.