/
Relay.xml
318 lines (318 loc) · 15.9 KB
/
Relay.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
<Type Name="Relay" FullName="Iot.Device.GrovePiDevice.Sensors.Relay">
<TypeSignature Language="C#" Value="public class Relay : Iot.Device.GrovePiDevice.Sensors.DigitalOutput" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Relay extends Iot.Device.GrovePiDevice.Sensors.DigitalOutput" />
<TypeSignature Language="DocId" Value="T:Iot.Device.GrovePiDevice.Sensors.Relay" />
<TypeSignature Language="VB.NET" Value="Public Class Relay
Inherits DigitalOutput" />
<TypeSignature Language="F#" Value="type Relay = class
 inherit DigitalOutput" />
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Iot.Device.GrovePiDevice.Sensors.DigitalOutput</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Relay module
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Relay (Iot.Device.GrovePiDevice.GrovePi grovePi, Iot.Device.GrovePiDevice.Models.GrovePort port);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Iot.Device.GrovePiDevice.GrovePi grovePi, valuetype Iot.Device.GrovePiDevice.Models.GrovePort port) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.GrovePiDevice.Sensors.Relay.#ctor(Iot.Device.GrovePiDevice.GrovePi,Iot.Device.GrovePiDevice.Models.GrovePort)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (grovePi As GrovePi, port As GrovePort)" />
<MemberSignature Language="F#" Value="new Iot.Device.GrovePiDevice.Sensors.Relay : Iot.Device.GrovePiDevice.GrovePi * Iot.Device.GrovePiDevice.Models.GrovePort -> Iot.Device.GrovePiDevice.Sensors.Relay" Usage="new Iot.Device.GrovePiDevice.Sensors.Relay (grovePi, port)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="grovePi" Type="Iot.Device.GrovePiDevice.GrovePi" />
<Parameter Name="port" Type="Iot.Device.GrovePiDevice.Models.GrovePort" />
</Parameters>
<Docs>
<param name="grovePi">The GrovePi class</param>
<param name="port">The grove Port, need to be in the list of SupportedPorts</param>
<summary>
Relay constructor
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Relay (Iot.Device.GrovePiDevice.GrovePi grovePi, Iot.Device.GrovePiDevice.Models.GrovePort port, bool inverted);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Iot.Device.GrovePiDevice.GrovePi grovePi, valuetype Iot.Device.GrovePiDevice.Models.GrovePort port, bool inverted) cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.GrovePiDevice.Sensors.Relay.#ctor(Iot.Device.GrovePiDevice.GrovePi,Iot.Device.GrovePiDevice.Models.GrovePort,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (grovePi As GrovePi, port As GrovePort, inverted As Boolean)" />
<MemberSignature Language="F#" Value="new Iot.Device.GrovePiDevice.Sensors.Relay : Iot.Device.GrovePiDevice.GrovePi * Iot.Device.GrovePiDevice.Models.GrovePort * bool -> Iot.Device.GrovePiDevice.Sensors.Relay" Usage="new Iot.Device.GrovePiDevice.Sensors.Relay (grovePi, port, inverted)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="grovePi" Type="Iot.Device.GrovePiDevice.GrovePi" />
<Parameter Name="port" Type="Iot.Device.GrovePiDevice.Models.GrovePort" />
<Parameter Name="inverted" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="grovePi">The GrovePi class</param>
<param name="port">The grove Port, need to be in the list of SupportedPorts</param>
<param name="inverted">If inverted, the relay is on when output is low and off when output is high</param>
<summary>
Relay constructor
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsInverted">
<MemberSignature Language="C#" Value="public bool IsInverted { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsInverted" />
<MemberSignature Language="DocId" Value="P:Iot.Device.GrovePiDevice.Sensors.Relay.IsInverted" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsInverted As Boolean" />
<MemberSignature Language="F#" Value="member this.IsInverted : bool" Usage="Iot.Device.GrovePiDevice.Sensors.Relay.IsInverted" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
If inverted, the relay is on when output is low and off when output is high
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsOn">
<MemberSignature Language="C#" Value="public bool IsOn { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsOn" />
<MemberSignature Language="DocId" Value="P:Iot.Device.GrovePiDevice.Sensors.Relay.IsOn" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property IsOn As Boolean" />
<MemberSignature Language="F#" Value="member this.IsOn : bool" Usage="Iot.Device.GrovePiDevice.Sensors.Relay.IsOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
True when the relay is on
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Off">
<MemberSignature Language="C#" Value="public void Off ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Off() cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.GrovePiDevice.Sensors.Relay.Off" />
<MemberSignature Language="VB.NET" Value="Public Sub Off ()" />
<MemberSignature Language="F#" Value="member this.Off : unit -> unit" Usage="relay.Off " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Switch off the relay
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="On">
<MemberSignature Language="C#" Value="public void On ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void On() cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.GrovePiDevice.Sensors.Relay.On" />
<MemberSignature Language="VB.NET" Value="Public Sub On ()" />
<MemberSignature Language="F#" Value="member this.On : unit -> unit" Usage="relay.On " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Switch on the relay
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SensorName">
<MemberSignature Language="C#" Value="public string SensorName { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SensorName" />
<MemberSignature Language="DocId" Value="P:Iot.Device.GrovePiDevice.Sensors.Relay.SensorName" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property SensorName As String" />
<MemberSignature Language="F#" Value="member this.SensorName : string" Usage="Iot.Device.GrovePiDevice.Sensors.Relay.SensorName" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get the name Relay
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:Iot.Device.GrovePiDevice.Sensors.Relay.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="relay.ToString " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Get "On" when relay if on and "Off" when relay is off
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Value">
<MemberSignature Language="C#" Value="public System.Device.Gpio.PinValue Value { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Device.Gpio.PinValue Value" />
<MemberSignature Language="DocId" Value="P:Iot.Device.GrovePiDevice.Sensors.Relay.Value" />
<MemberSignature Language="VB.NET" Value="Public Property Value As PinValue" />
<MemberSignature Language="F#" Value="member this.Value : System.Device.Gpio.PinValue with get, set" Usage="Iot.Device.GrovePiDevice.Sensors.Relay.Value" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Iot.Device.Bindings</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>1.2.0.0</AssemblyVersion>
<AssemblyVersion>1.3.0.0</AssemblyVersion>
<AssemblyVersion>1.4.0.0</AssemblyVersion>
<AssemblyVersion>1.5.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Device.Gpio.PinValue</ReturnType>
</ReturnValue>
<Docs>
<summary>
Get/set the state of the relay, 0 for off, 1 for on. Wehn set, anything not 0 will be considered as on
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>