Interface IPlatformOS
Provides an abstraction for OS services such as configuration so that Meadow can operate on different OS's and platforms.
Assembly: Meadow.Contracts.dll
View Source
public interface IPlatformOS : IPowerController
Properties
OSVersion
OS version.
View Source
string OSVersion { get; }
OSBuildDate
OS build date and time.
View Source
string OSBuildDate { get; }
RuntimeVersion
.NET Runtime version install on the device.
View Source
string RuntimeVersion { get; }
RebootOnUnhandledException
Should the system reboot on an exception?
View Source
bool RebootOnUnhandledException { get; }
InitializationTimeout
Number of seconds allowed for the system to initialize.
View Source
uint InitializationTimeout { get; }
AutomaticallyStartNetwork
Should a WiFi connection be made on startup.
View Source
bool AutomaticallyStartNetwork { get; }
SelectedNetwork
Which network is selected in meadow.config.yaml.
View Source
IPlatformOS.NetworkConnectionType SelectedNetwork { get; }
SdStorageSupported
Should SD card support be enabled on this platform?
View Source
bool SdStorageSupported { get; }
ReservedPins
Names of any pins that should be reserved for OS use.
View Source
string ReservedPins { get; }
NtpServers
Gets a list of NTP servers used for time synchronization
View Source
string[] NtpServers { get; }
LaunchArguments
The command line arguments provided when the Meadow application was launched
View Source
string[]? LaunchArguments { get; }
NtpClient
Gets the OS INtpClient instance
View Source
INtpClient NtpClient { get; }
FileSystem
FileSystemInfo property
View Source
IPlatformOS.FileSystemInfo FileSystem { get; }
Methods
GetConfigurationValue<T>(ConfigurationValues)
Get a configuration value, as specified in meadow.config.yaml, from the OS.
View Source
T GetConfigurationValue<T>(IPlatformOS.ConfigurationValues item) where T : struct
Returns
<T>: Value for the specified item.
Parameters
| Type | Name | Description |
|---|---|---|
| Meadow.IPlatformOS.ConfigurationValues | item | Item to retrieve. |
Type Parameters
| Name | Description |
|---|---|
T | Type of the object being retrieved. |
SetConfigurationValue<T>(ConfigurationValues, T)
Send a configuration value to the OS.
View Source
void SetConfigurationValue<T>(IPlatformOS.ConfigurationValues item, T value) where T : struct
Parameters
| Type | Name | Description |
|---|---|---|
| Meadow.IPlatformOS.ConfigurationValues | item | Item to set. |
<T> | value | Value of item. |
Type Parameters
| Name | Description |
|---|---|
T | Type of the object being set. |
GetPublicKeyInPemFormat()
Retrieves the device's public key in PEM format
View Source
string? GetPublicKeyInPemFormat()
Returns
System.String: A public key, including header and footer, or null if none is found### RsaDecrypt(byte[], string)
Performs RSA decryption of a value using the Meadow device certificate.
View Source
byte[] RsaDecrypt(byte[] encryptedValue, string privateKeyPem)
Returns
System.Byte[]: The decrypted value
Parameters
| Type | Name | Description |
|---|---|---|
System.Byte[] | encryptedValue | The value to decrypt |
System.String | privateKeyPem | The private key to use for decryption (in PEM format) |
AesDecrypt(byte[], byte[], byte[])
Performs AES decryption of a value using the Meadow device certificate.
View Source
byte[] AesDecrypt(byte[] encryptedValue, byte[] key, byte[] iv)
Returns
System.Byte[]: The decrypted value
Parameters
| Type | Name | Description |
|---|---|---|
System.Byte[] | encryptedValue | The value to decrypt |
System.Byte[] | key | The key used for encrypting the buffer |
System.Byte[] | iv | The initialization vector to use for decryption |
Initialize(DeviceCapabilities, string[]?)
Initializes platform-specific OS features
View Source
void Initialize(DeviceCapabilities capabilities, string[]? args)
Parameters
| Type | Name | Description |
|---|---|---|
| Meadow.DeviceCapabilities | capabilities | |
System.String[] | args | The command line arguments provided when the Meadow application was launched |
GetCpuTemperature()
Gets the current CPU temperature
View Source
Temperature GetCpuTemperature()
Returns
GetPrimaryDiskSpaceInUse()
Gets the amount of storage space in use on the primary storage device
View Source
DigitalStorage GetPrimaryDiskSpaceInUse()
Returns
GetSerialPortNames()
Gets a list of currently available serial ports
View Source
SerialPortName[] GetSerialPortNames()
Returns
Meadow.Hardware.SerialPortName[]
GetSerialPortName(string)
Finds a platform serial port name by either friendly or system name
View Source
SerialPortName? GetSerialPortName(string portName)
Returns
Meadow.Hardware.SerialPortName
Parameters
| Type | Name |
|---|---|
System.String | portName |
GetStartupMessages()
Retrieves any messages generated by the Meadow host OS prior to starting the Meadow stack
View Source
IEnumerable<PlatformOsMessage>? GetStartupMessages()
Returns
System.Collections.Generic.IEnumerable<Meadow.PlatformOsMessage>
SetClock(DateTime)
Sets the platform OS clock
View Source
void SetClock(DateTime dateTime)
Parameters
| Type | Name |
|---|---|
System.DateTime | dateTime |
GetProcessorUtilization()
Retrieves the current usage (as a percentage in the range of 0-100) for each processor/core
View Source
int[] GetProcessorUtilization()
Returns
System.Int32[]
SetServerCertificateValidationMode(ServerCertificateValidationMode)
Sets the server certificate validation mode for SSL/TLS protocols
View Source
void SetServerCertificateValidationMode(ServerCertificateValidationMode authmode)
Parameters
| Type | Name | Description |
|---|---|---|
| Meadow.ServerCertificateValidationMode | authmode | The validation mode to be set: None for no validation, Optional for facultative validation, |
| Required for mandatory validation |
Exceptions
System.ArgumentException
Thrown when an invalid validation mode is provided
System.Exception
Thrown when there is an error setting the validation mode
Events
MeadowSystemError
This event is raised in the event that an exception or error occurs outside of the managed stack, such as with a coprocessor
View Source
event EventHandler<MeadowSystemErrorInfo>? MeadowSystemError
Event Type
System.EventHandler<Meadow.MeadowSystemErrorInfo>