Class Mcp3201 | Meadow.Foundation API website

Remarks

Mcp3201
Status
Source code	GitHub
Datasheet(s)	GitHub
NuGet package

Code Example

Mcp3201 mcp;

IAnalogInputPort port;

public override Task Initialize()
{
    Resolver.Log.Info("Initialize");

    IDigitalOutputPort chipSelectPort = Device.CreateDigitalOutputPort(Device.Pins.D14);

    mcp = new Mcp3201(Device.CreateSpiBus(), chipSelectPort);

    port = mcp.CreateAnalogInputPort();

    port.Updated += (s, result) =>
    {
        Resolver.Log.Info($"Analog event, new voltage: {result.New.Volts}V, old: {result.Old?.Volts}V");
    };

    var observer = IAnalogInputPort.CreateObserver(
        handler: result =>
        {
            Resolver.Log.Info($"Analog observer triggered; new: {result.New.Volts}V, old: {result.Old?.Volts}V");
        },
        filter: result =>
        {
            if (result.Old is { } oldValue)
            {
                return (result.New - oldValue).Abs().Volts > 0.1;
            }
            else { return false; }
        }
    );
    port.Subscribe(observer);

    return base.Initialize();
}

public override Task Run()
{
    Resolver.Log.Info("Run");

    port.StartUpdating();

    Resolver.Log.Info("Run complete");

    return Task.CompletedTask;
}

Sample project(s) available on GitHub

Characteristic	Locus
Inheritance	object Mcp3xxx > Mcp3201
Implements	IAnalogInputController IPinController ISpiPeripheral IDisposable
Inherited Members	Mcp3xxx.IsDisposed Mcp3xxx.SpiComms Mcp3xxx.ChannelCount Mcp3xxx.DefaultSpiBusSpeed Mcp3xxx.SpiBusSpeed Mcp3xxx.DefaultSpiBusMode Mcp3xxx.SpiBusMode Mcp3xxx.AdcResolutionInBits Mcp3xxx.CreateAnalogInputPort(IPin, int) Mcp3xxx.CreateAnalogInputPort(IPin, int, TimeSpan, Voltage) Mcp3xxx.CreateAnalogInputPort(IPin, int, TimeSpan, Voltage, Mcp3xxx.InputType) Mcp3xxx.CreateAnalogInputArray(params IPin[]) Mcp3xxx.ValidateChannel(int, int) Mcp3xxx.ValidateChannelPairing(int, int) Mcp3xxx.ReadSingleEnded(int) Mcp3xxx.ReadPseudoDifferential(int, int) Mcp3xxx.ReadDifferential(int, int) Mcp3xxx.ReadInternalRaw(int, int, int) Mcp3xxx.Dispose() Mcp3xxx.Dispose(bool) object.Equals(object) object.Equals(object, object) object.GetHashCode() object.GetType() object.MemberwiseClone() object.ReferenceEquals(object, object) object.ToString()
Namespace	Meadow.Foundation.ICs.IOExpanders
Assembly	Mcp3xxx.dll

Syntax

public class Mcp3201 : Mcp3xxx, IAnalogInputController, IPinController, ISpiPeripheral, IDisposable

Constructors

Mcp3201(ISpiBus, IDigitalOutputPort)

Constructs Mcp3201 instance

Declaration

public Mcp3201(ISpiBus spiBus, IDigitalOutputPort chipSelectPort)

Parameters

Type	Name	Description
ISpiBus	spiBus	The SPI bus
IDigitalOutputPort	chipSelectPort	Chip select port

Remarks

Mcp3201
Status
Source code	GitHub
Datasheet(s)	GitHub
NuGet package

Code Example

Mcp3201 mcp;

IAnalogInputPort port;

public override Task Initialize()
{
    Resolver.Log.Info("Initialize");

    IDigitalOutputPort chipSelectPort = Device.CreateDigitalOutputPort(Device.Pins.D14);

    mcp = new Mcp3201(Device.CreateSpiBus(), chipSelectPort);

    port = mcp.CreateAnalogInputPort();

    port.Updated += (s, result) =>
    {
        Resolver.Log.Info($"Analog event, new voltage: {result.New.Volts}V, old: {result.Old?.Volts}V");
    };

    var observer = IAnalogInputPort.CreateObserver(
        handler: result =>
        {
            Resolver.Log.Info($"Analog observer triggered; new: {result.New.Volts}V, old: {result.Old?.Volts}V");
        },
        filter: result =>
        {
            if (result.Old is { } oldValue)
            {
                return (result.New - oldValue).Abs().Volts > 0.1;
            }
            else { return false; }
        }
    );
    port.Subscribe(observer);

    return base.Initialize();
}

public override Task Run()
{
    Resolver.Log.Info("Run");

    port.StartUpdating();

    Resolver.Log.Info("Run complete");

    return Task.CompletedTask;
}

Sample project(s) available on GitHub

Mcp3201(ISpiBus, IPin)

Constructs Mcp3201 instance

Declaration

public Mcp3201(ISpiBus spiBus, IPin chipSelectPin)

Parameters

Type	Name	Description
ISpiBus	spiBus	The SPI bus
IPin	chipSelectPin	Chip select pin

Remarks

Mcp3201
Status
Source code	GitHub
Datasheet(s)	GitHub
NuGet package

Code Example

Mcp3201 mcp;

IAnalogInputPort port;

public override Task Initialize()
{
    Resolver.Log.Info("Initialize");

    IDigitalOutputPort chipSelectPort = Device.CreateDigitalOutputPort(Device.Pins.D14);

    mcp = new Mcp3201(Device.CreateSpiBus(), chipSelectPort);

    port = mcp.CreateAnalogInputPort();

    port.Updated += (s, result) =>
    {
        Resolver.Log.Info($"Analog event, new voltage: {result.New.Volts}V, old: {result.Old?.Volts}V");
    };

    var observer = IAnalogInputPort.CreateObserver(
        handler: result =>
        {
            Resolver.Log.Info($"Analog observer triggered; new: {result.New.Volts}V, old: {result.Old?.Volts}V");
        },
        filter: result =>
        {
            if (result.Old is { } oldValue)
            {
                return (result.New - oldValue).Abs().Volts > 0.1;
            }
            else { return false; }
        }
    );
    port.Subscribe(observer);

    return base.Initialize();
}

public override Task Run()
{
    Resolver.Log.Info("Run");

    port.StartUpdating();

    Resolver.Log.Info("Run complete");

    return Task.CompletedTask;
}

Sample project(s) available on GitHub

Properties

Pins

The pins

Declaration

public Mcp3201.PinDefinitions Pins { get; }

Property Value

Type	Description
Mcp3201.PinDefinitions

Remarks

Mcp3201
Status
Source code	GitHub
Datasheet(s)	GitHub
NuGet package

Code Example

Mcp3201 mcp;

IAnalogInputPort port;

public override Task Initialize()
{
    Resolver.Log.Info("Initialize");

    IDigitalOutputPort chipSelectPort = Device.CreateDigitalOutputPort(Device.Pins.D14);

    mcp = new Mcp3201(Device.CreateSpiBus(), chipSelectPort);

    port = mcp.CreateAnalogInputPort();

    port.Updated += (s, result) =>
    {
        Resolver.Log.Info($"Analog event, new voltage: {result.New.Volts}V, old: {result.Old?.Volts}V");
    };

    var observer = IAnalogInputPort.CreateObserver(
        handler: result =>
        {
            Resolver.Log.Info($"Analog observer triggered; new: {result.New.Volts}V, old: {result.Old?.Volts}V");
        },
        filter: result =>
        {
            if (result.Old is { } oldValue)
            {
                return (result.New - oldValue).Abs().Volts > 0.1;
            }
            else { return false; }
        }
    );
    port.Subscribe(observer);

    return base.Initialize();
}

public override Task Run()
{
    Resolver.Log.Info("Run");

    port.StartUpdating();

    Resolver.Log.Info("Run complete");

    return Task.CompletedTask;
}

Sample project(s) available on GitHub

Methods

CreateAnalogInputPort(int)

Create an analog input port for a pin

Declaration

public IAnalogInputPort CreateAnalogInputPort(int sampleCount = 64)

Parameters

Type	Name	Description
int	sampleCount

Returns

Type	Description
IAnalogInputPort

Remarks

Mcp3201
Status
Source code	GitHub
Datasheet(s)	GitHub
NuGet package

Code Example

Mcp3201 mcp;

IAnalogInputPort port;

public override Task Initialize()
{
    Resolver.Log.Info("Initialize");

    IDigitalOutputPort chipSelectPort = Device.CreateDigitalOutputPort(Device.Pins.D14);

    mcp = new Mcp3201(Device.CreateSpiBus(), chipSelectPort);

    port = mcp.CreateAnalogInputPort();

    port.Updated += (s, result) =>
    {
        Resolver.Log.Info($"Analog event, new voltage: {result.New.Volts}V, old: {result.Old?.Volts}V");
    };

    var observer = IAnalogInputPort.CreateObserver(
        handler: result =>
        {
            Resolver.Log.Info($"Analog observer triggered; new: {result.New.Volts}V, old: {result.Old?.Volts}V");
        },
        filter: result =>
        {
            if (result.Old is { } oldValue)
            {
                return (result.New - oldValue).Abs().Volts > 0.1;
            }
            else { return false; }
        }
    );
    port.Subscribe(observer);

    return base.Initialize();
}

public override Task Run()
{
    Resolver.Log.Info("Run");

    port.StartUpdating();

    Resolver.Log.Info("Run complete");

    return Task.CompletedTask;
}

Sample project(s) available on GitHub

CreateAnalogInputPort(int, TimeSpan, Voltage)

Create an analog input port for a pin

Declaration

public IAnalogInputPort CreateAnalogInputPort(int sampleCount, TimeSpan sampleInterval, Voltage voltageReference)

Parameters

Type	Name	Description
int	sampleCount
TimeSpan	sampleInterval
Voltage	voltageReference

Returns

Type	Description
IAnalogInputPort

Remarks

Mcp3201
Status
Source code	GitHub
Datasheet(s)	GitHub
NuGet package

Code Example

Mcp3201 mcp;

IAnalogInputPort port;

public override Task Initialize()
{
    Resolver.Log.Info("Initialize");

    IDigitalOutputPort chipSelectPort = Device.CreateDigitalOutputPort(Device.Pins.D14);

    mcp = new Mcp3201(Device.CreateSpiBus(), chipSelectPort);

    port = mcp.CreateAnalogInputPort();

    port.Updated += (s, result) =>
    {
        Resolver.Log.Info($"Analog event, new voltage: {result.New.Volts}V, old: {result.Old?.Volts}V");
    };

    var observer = IAnalogInputPort.CreateObserver(
        handler: result =>
        {
            Resolver.Log.Info($"Analog observer triggered; new: {result.New.Volts}V, old: {result.Old?.Volts}V");
        },
        filter: result =>
        {
            if (result.Old is { } oldValue)
            {
                return (result.New - oldValue).Abs().Volts > 0.1;
            }
            else { return false; }
        }
    );
    port.Subscribe(observer);

    return base.Initialize();
}

public override Task Run()
{
    Resolver.Log.Info("Run");

    port.StartUpdating();

    Resolver.Log.Info("Run complete");

    return Task.CompletedTask;
}

Sample project(s) available on GitHub

IsInputTypeSupported(InputType)

Is the input type supported on this MCP3xxx version

Declaration

public override bool IsInputTypeSupported(Mcp3xxx.InputType inputType)

Parameters

Type	Name	Description
Mcp3xxx.InputType	inputType	The input type

Returns

Type	Description
bool	True if supported, false if not supported

Overrides

Mcp3xxx.IsInputTypeSupported(Mcp3xxx.InputType)

Remarks

Mcp3201
Status
Source code	GitHub
Datasheet(s)	GitHub
NuGet package

Code Example

Mcp3201 mcp;

IAnalogInputPort port;

public override Task Initialize()
{
    Resolver.Log.Info("Initialize");

    IDigitalOutputPort chipSelectPort = Device.CreateDigitalOutputPort(Device.Pins.D14);

    mcp = new Mcp3201(Device.CreateSpiBus(), chipSelectPort);

    port = mcp.CreateAnalogInputPort();

    port.Updated += (s, result) =>
    {
        Resolver.Log.Info($"Analog event, new voltage: {result.New.Volts}V, old: {result.Old?.Volts}V");
    };

    var observer = IAnalogInputPort.CreateObserver(
        handler: result =>
        {
            Resolver.Log.Info($"Analog observer triggered; new: {result.New.Volts}V, old: {result.Old?.Volts}V");
        },
        filter: result =>
        {
            if (result.Old is { } oldValue)
            {
                return (result.New - oldValue).Abs().Volts > 0.1;
            }
            else { return false; }
        }
    );
    port.Subscribe(observer);

    return base.Initialize();
}

public override Task Run()
{
    Resolver.Log.Info("Run");

    port.StartUpdating();

    Resolver.Log.Info("Run complete");

    return Task.CompletedTask;
}

Sample project(s) available on GitHub

ReadInternal(int, InputType, int)

Reads a value from the device

Declaration

protected override int ReadInternal(int channel, Mcp3xxx.InputType inputType, int adcResolutionBits)

Parameters

Type	Name	Description
int	channel	Channel to read - for differential inputs this represents a channel pair (valid values: 0 - channelcount - 1 or 0 - channelcount / 2 - 1 with differential inputs)
Mcp3xxx.InputType	inputType	The type of input channel to read
int	adcResolutionBits	The number of bits in the returned value

Returns

Type	Description
int	A value corresponding to relative voltage level on specified device channel

Overrides

Mcp3xxx.ReadInternal(int, Mcp3xxx.InputType, int)

Remarks

Mcp3201
Status
Source code	GitHub
Datasheet(s)	GitHub
NuGet package

Code Example

Mcp3201 mcp;

IAnalogInputPort port;

public override Task Initialize()
{
    Resolver.Log.Info("Initialize");

    IDigitalOutputPort chipSelectPort = Device.CreateDigitalOutputPort(Device.Pins.D14);

    mcp = new Mcp3201(Device.CreateSpiBus(), chipSelectPort);

    port = mcp.CreateAnalogInputPort();

    port.Updated += (s, result) =>
    {
        Resolver.Log.Info($"Analog event, new voltage: {result.New.Volts}V, old: {result.Old?.Volts}V");
    };

    var observer = IAnalogInputPort.CreateObserver(
        handler: result =>
        {
            Resolver.Log.Info($"Analog observer triggered; new: {result.New.Volts}V, old: {result.Old?.Volts}V");
        },
        filter: result =>
        {
            if (result.Old is { } oldValue)
            {
                return (result.New - oldValue).Abs().Volts > 0.1;
            }
            else { return false; }
        }
    );
    port.Subscribe(observer);

    return base.Initialize();
}

public override Task Run()
{
    Resolver.Log.Info("Run");

    port.StartUpdating();

    Resolver.Log.Info("Run complete");

    return Task.CompletedTask;
}

Sample project(s) available on GitHub