PYROS-IRAP / pyros

Blame view

config/pyros_observatory/general/schemas/schema_device-2.0.yml 4.33 KB
Edit Raw Normal View History
c124548f   Alain Klotz   Ajout de la confi... 
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
 
schema;schema_component_attributes:
  type: map
  required: True
  mapping:
    attribute:
      type: map
      required: True
      mapping:
        key:
          type: str
          required: True
        # is_* are False by default
        is_editable:
          type: bool
        is_container:
          type: bool
        is_enum:
          type: bool
        value:
          type: any
          required: True
        liminf:
          type: number
        limsup:
          type: number
        label:
          type: any
        unit:
          type: any
d5cacc8d   Alain Klotz   Ajout de descript... 
30
31
 
        description:
          type: any
3d4ab326   Alexis Koralewski   adding new attrib... 
32
33
 
        placeholder:
          type: str
aa33c09f   Alain Klotz   Add output_data i... 
34
35
36
37
38
 

schema;schema_component_output_data:
  type: map
  required: False
  mapping:
403d32ff   Alain Klotz   Update of the sch... 
39
 
    data:
aa33c09f   Alain Klotz   Add output_data i... 
40
41
42
 
      type: map
      required: False
      mapping:
403d32ff   Alain Klotz   Update of the sch... 
43
44
 
        key: # e.g. link with Json keys
          type: any
aa33c09f   Alain Klotz   Add output_data i... 
45
 
          required: True
403d32ff   Alain Klotz   Update of the sch... 
46
 
        category: # general category of the sensor (official list)
aa33c09f   Alain Klotz   Add output_data i... 
47
48
 
          type: str
          required: True
403d32ff   Alain Klotz   Update of the sch... 
49
50
51
 
        external: # internal/external of the building (information)
          type: bool
        monitoring_name: # Monitoring unique value (official list)
aa33c09f   Alain Klotz   Add output_data i... 
52
 
          type: str
403d32ff   Alain Klotz   Update of the sch... 
53
54
55
56
57
 
        quality: # float 0 to 1
            type: float
        time_sampling: # period (s) to record in the history database
            type: float          
        label: # Label for web display
aa33c09f   Alain Klotz   Add output_data i... 
58
 
          type: str
403d32ff   Alain Klotz   Update of the sch... 
59
60
61
62
63
64
 
        value_type: # value format for web display
          type: any 
        unit: # Unit for web display
          type: str 
        description: # for the web display
            type: str
aa33c09f   Alain Klotz   Add output_data i... 
65
c124548f   Alain Klotz   Ajout de la confi... 
66
67
68
69
70
71
72
73
74
75
76
77
 
schema;schema_capability:
  type: map
  required: True
  mapping: 
    component:
      type: str
      required: True
    attributes:
      type: seq
      required: False # True if we're not using default values
      seq:
        - include : schema_component_attributes
aa33c09f   Alain Klotz   Add output_data i... 
78
79
80
81
82
83
 
    output_data:
      type: seq
      required: False # True if we're not using default values
      seq:
        - include : schema_component_output_data
c124548f   Alain Klotz   Ajout de la confi... 
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
 

# old version
# schema;schema_capability:
#   type: map
#   required: True
#   mapping:
   
schema;schema_capabilities:
  type: seq
  sequence:
    - type: map
      mapping:
        CAPABILITY:
          include: schema_capability

schema;schema_device:
  type: map
  required: True
  mapping:
    generic:
      type: str
      required: False
    inventory_label:
      type: str
      required: True
    manufacturer:
      type: str
      required: False
    model: 
      type: str
      required: False
    description: 
      type: str
      required: False
    sn: 
      type: text
      required: True
    power:
      type: map
      required: False
      mapping:
        voltage:
3f1744c1   pyros_astroguita   add pyros_seq_tmp fn 
126
 
          type: float
c124548f   Alain Klotz   Ajout de la confi... 
127
 
        intensity:
3f1744c1   pyros_astroguita   add pyros_seq_tmp fn 
128
 
          type: float
c124548f   Alain Klotz   Ajout de la confi... 
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
 
        socket:
          type: str
    hostname:
      type: str
    virtual_machine:
      type: bool
    network_interfaces:
      type: seq
      sequence:
        - type: str
    connector:
      type: map
      
      mapping:
        input:
          type: str
          
        output:
          type: str

    comm:
      type: map
      required: False
      mapping:
        supports:
          type: seq
          required: False
          sequence:
            - type: str
        languages:
          type: seq
          required: False
          sequence:
            - type: str
        support:
          type: str
          required: False
        language:
          type: str
          required: False
7ce93a0a   Alain Klotz   Ajout des mots cl... 
169
170
171
 
        tcp_port:
          type: int
          required: False
c124548f   Alain Klotz   Ajout de la confi... 
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
 
          
    os: 
      type: str
      
    os_version: 
      type: str
      
    protocol:
      type: map
      
      mapping:
        transport:
          type: str
          
        langage: 
          type: str
          
        read: 
          type: bool
            
        write: 
          type: bool
            
    CAPABILITIES:
      include: schema_capabilities
      required: True
    ATTACHED_DEVICES:
      type: seq
      sequence:
        - type: map
          mapping:
            file:
              type: str

type: map
mapping:
    schema:
        type: str
        required: True
    DEVICE:
adb4a3dd   Alexis Koralewski   Updating script f... 
212
 
      include: schema_device