Remarks
MagneticSwitch | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
Code Example
public override Task Initialize()
{
Resolver.Log.Info("Initialize...");
var magneticSwitch = new MagneticSwitch(Device.Pins.D13);
magneticSwitch.Changed += (s, e) =>
{
Resolver.Log.Info($"Switched - open {magneticSwitch.IsOn}");
};
return Task.CompletedTask;
}
Sample project(s) available on GitHub
Wiring Example
MagneticSwitch | Meadow Pin |
---|---|
GND | GND |
VCC | 3.3V |
RX | D01 |
TX | D00 |
Characteristic | Locus |
---|---|
Inheritance | object > MagneticSwitch |
Implements | ISwitch ISensor<bool> |
Inherited Members | object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString() |
Namespace | Meadow.Foundation.Grove.Sensors.Switches |
Assembly | MagneticSwitch.dll |
Syntax
public class MagneticSwitch : ISwitch, ISensor<bool>
Constructors
MagneticSwitch(IDigitalInterruptPort)
Creates a MagneticSwitch driver
Declaration
public MagneticSwitch(IDigitalInterruptPort signalPort)
Parameters
Type | Name | Description |
---|---|---|
IDigitalInterruptPort | signalPort |
Remarks
MagneticSwitch | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
Code Example
public override Task Initialize()
{
Resolver.Log.Info("Initialize...");
var magneticSwitch = new MagneticSwitch(Device.Pins.D13);
magneticSwitch.Changed += (s, e) =>
{
Resolver.Log.Info($"Switched - open {magneticSwitch.IsOn}");
};
return Task.CompletedTask;
}
Sample project(s) available on GitHub
Wiring Example
MagneticSwitch | Meadow Pin |
---|---|
GND | GND |
VCC | 3.3V |
RX | D01 |
TX | D00 |
MagneticSwitch(IPin)
Creates a MagneticSwitch driver
Declaration
public MagneticSwitch(IPin inputPin)
Parameters
Type | Name | Description |
---|---|---|
IPin | inputPin |
Remarks
MagneticSwitch | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
Code Example
public override Task Initialize()
{
Resolver.Log.Info("Initialize...");
var magneticSwitch = new MagneticSwitch(Device.Pins.D13);
magneticSwitch.Changed += (s, e) =>
{
Resolver.Log.Info($"Switched - open {magneticSwitch.IsOn}");
};
return Task.CompletedTask;
}
Sample project(s) available on GitHub
Wiring Example
MagneticSwitch | Meadow Pin |
---|---|
GND | GND |
VCC | 3.3V |
RX | D01 |
TX | D00 |
Properties
IsOn
Returns the state of the switch
Declaration
public bool IsOn { get; }
Property Value
Type | Description |
---|---|
bool |
Remarks
MagneticSwitch | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
Code Example
public override Task Initialize()
{
Resolver.Log.Info("Initialize...");
var magneticSwitch = new MagneticSwitch(Device.Pins.D13);
magneticSwitch.Changed += (s, e) =>
{
Resolver.Log.Info($"Switched - open {magneticSwitch.IsOn}");
};
return Task.CompletedTask;
}
Sample project(s) available on GitHub
Wiring Example
MagneticSwitch | Meadow Pin |
---|---|
GND | GND |
VCC | 3.3V |
RX | D01 |
TX | D00 |
Methods
Read()
Returns the state of the switch
Declaration
public Task<bool> Read()
Returns
Type | Description |
---|---|
Task<bool> |
Remarks
MagneticSwitch | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
Code Example
public override Task Initialize()
{
Resolver.Log.Info("Initialize...");
var magneticSwitch = new MagneticSwitch(Device.Pins.D13);
magneticSwitch.Changed += (s, e) =>
{
Resolver.Log.Info($"Switched - open {magneticSwitch.IsOn}");
};
return Task.CompletedTask;
}
Sample project(s) available on GitHub
Wiring Example
MagneticSwitch | Meadow Pin |
---|---|
GND | GND |
VCC | 3.3V |
RX | D01 |
TX | D00 |
Events
Changed
Event triggered when status has changed
Declaration
public event EventHandler Changed
Event Type
Type | Description |
---|---|
EventHandler |
Remarks
MagneticSwitch | |
---|---|
Status | |
Source code | GitHub |
NuGet package |
Code Example
public override Task Initialize()
{
Resolver.Log.Info("Initialize...");
var magneticSwitch = new MagneticSwitch(Device.Pins.D13);
magneticSwitch.Changed += (s, e) =>
{
Resolver.Log.Info($"Switched - open {magneticSwitch.IsOn}");
};
return Task.CompletedTask;
}
Sample project(s) available on GitHub
Wiring Example
MagneticSwitch | Meadow Pin |
---|---|
GND | GND |
VCC | 3.3V |
RX | D01 |
TX | D00 |