Class Mcp7940m.Alarm

Namespace

Iot.Device.Mcp7940xx

Assembly

Iot.Device.Mcp7940xx.dll

Represents an alarm on a Mcp7940xx series device.

public class Mcp7940m.Alarm

Inheritance

object

Mcp7940m.Alarm

Constructors

Alarm(AlarmMatchMode, byte, byte, byte, byte, byte, DayOfWeek)

Initializes a new instance of the Mcp7940m.Alarm class.

public Alarm(AlarmMatchMode matchMode, byte month = 1, byte day = 1, byte hour = 0, byte minute = 0, byte second = 0, DayOfWeek dayOfWeek = DayOfWeek.Sunday)

Parameters

matchMode AlarmMatchMode

The mode used to determine when the alarm should trigger.

month byte

The month that the alarm will be triggerd on.

day byte

The day-of-the-month that the alarm will be triggerd on.

hour byte

The hour that the alarm will be triggerd on.

minute byte

The minute that the alarm will be triggerd on.

second byte

The second that the alarm will be triggerd on.

dayOfWeek DayOfWeek

The day-of-the-week that the alarm will be triggerd on.

Remarks

Month, day, hour, minute, and second will be clamped to their respective valid ranges.

Properties

Day

Gets or sets the day-of-the-month that the alarm will be triggerd on.

public byte Day { get; set; }

Property Value

byte

Remarks

The value is clamped to the range 1 through 31.

DayOfWeek

Gets or sets the day-of-the-week that the alarm will be triggerd on.

public DayOfWeek DayOfWeek { get; set; }

Property Value

DayOfWeek

Hour

Gets or sets the hour that the alarm will be triggerd on.

public byte Hour { get; set; }

Property Value

byte

Remarks

The value is clamped to the range 0 through 23.

MatchMode

Gets or sets the mode used to determine when the alarm should trigger.

public AlarmMatchMode MatchMode { get; set; }

Property Value

AlarmMatchMode

Minute

Gets or sets the minute that the alarm will be triggerd on.

public byte Minute { get; set; }

Property Value

byte

Remarks

The value is clamped to the range 0 through 59.

Month

Gets or sets the month that the alarm will be triggerd on.

public byte Month { get; set; }

Property Value

byte

Remarks

The value is clamped to the range 1 through 12.

Second

Gets or sets the second that the alarm will be triggerd on.

public byte Second { get; set; }

Property Value

byte

Remarks

The value is clamped to the range 0 through 59.

Methods

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.

Remarks

Available only in mscorlib build with support for System.Reflection.