harp-python/harp/data/common.yml at 57918ec29891f15a780d7eb396fefd7d7d249eed · harp-tech/harp-python · GitHub

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
# yaml-language-server: $schema=registers.json
registers:
  WhoAmI:
    address: 0
    type: U16
    access: Read
    description: Specifies the identity class of the device.
  HardwareVersionHigh:
    address: 1
    type: U8
    access: Read
    description: Specifies the major hardware version of the device.
  HardwareVersionLow:
    address: 2
    type: U8
    access: Read
    description: Specifies the minor hardware version of the device.
  AssemblyVersion:
    address: 3
    type: U8
    access: Read
    description: Specifies the version of the assembled components in the device.
  CoreVersionHigh:
    address: 4
    type: U8
    access: Read
    description: Specifies the major version of the Harp core implemented by the device.
  CoreVersionLow:
    address: 5
    type: U8
    access: Read
    description: Specifies the minor version of the Harp core implemented by the device.
  FirmwareVersionHigh:
    address: 6
    type: U8
    access: Read
    description: Specifies the major version of the Harp core implemented by the device.
  FirmwareVersionLow:
    address: 7
    type: U8
    access: Read
    description: Specifies the minor version of the Harp core implemented by the device.
  TimestampSeconds:
    address: 8
    type: U32
    access: [Read, Write, Event]
    description: Stores the integral part of the system timestamp, in seconds.
    volatile: true
  TimestampMicroseconds:
    address: 9
    type: U16
    access: Read
    description: Stores the fractional part of the system timestamp, in microseconds.
    volatile: true
  OperationControl:
    address: 10
    type: U8
    access: Write
    description: Stores the configuration mode of the device.
    payloadSpec:
      OperationMode:
        description: Specifies the operation mode of the device.
        maskType: OperationMode
        mask: 0x3
      DumpRegisters:
        description: Specifies whether the device should report the content of all registers on initialization.
        interfaceType: bool
        mask: 0x8
      MuteReplies:
        description: Specifies whether the replies to all commands will be muted, i.e. not sent by the device.
        interfaceType: bool
        mask: 0x10
      VisualIndicators:
        description: Specifies the state of all visual indicators on the device.
        maskType: LedState
        mask: 0x20
      OperationLed:
        description: Specifies whether the device state LED should report the operation mode of the device.
        maskType: LedState
        mask: 0x40
      Heartbeat:
        description: Specifies whether the device should report the content of the seconds register each second.
        maskType: EnableFlag
        mask: 0x80
  ResetDevice:
    address: 11
    type: U8
    access: Write
    maskType: ResetFlags
    description: Resets the device and saves non-volatile registers.
  DeviceName:
    address: 12
    type: U8
    length: 25
    access: Write
    description: Stores the user-specified device name.
  SerialNumber:
    address: 13
    type: U16
    access: Write
    description: Specifies the unique serial number of the device.
  ClockConfiguration:
    address: 14
    type: U8
    access: Write
    maskType: ClockConfigurationFlags
    description: Specifies the configuration for the device synchronization clock.
groupMasks:
  OperationMode:
    description: Specifies the operation mode of the device.
    values:
      Standby: 0
      Active: 1
      Speed: 3
  EnableFlag:
    description: Specifies whether a specific register flag is enabled or disabled.
    values:
      Disabled: 0
      Enabled: 1
  LedState:
    description: Specifies the state of an LED on the device.
    values:
      Off: 0
      On: 1
bitMasks:
  ResetFlags:
    description: Specifies the behavior of the non-volatile registers when resetting the device.
    bits:
      None: 0
      RestoreDefault: 0x1
      RestoreEeprom: 0x2
      Save: 0x4
      RestoreName: 0x8
      BootFromDefault: 0x40
      BootFromEeprom: 0x80
  ClockConfigurationFlags:
    description: Specifies configuration flags for the device synchronization clock.
    bits:
      None: 0
      ClockRepeater: 0x1
      ClockGenerator: 0x2
      RepeaterCapability: 0x8
      GeneratorCapability: 0x10
      ClockUnlock: 0x40
      ClockLock: 0x80