Class IotItem

Namespace

Kepware.Api.Model

Assembly

Kepware.Api.dll

Represents an IoT Item in the IoT Gateway. IoT Items are children of agent types and identify the data objects exposed by the agent.

[Endpoint("/config/v1/project/_iot_gateway/mqtt_clients/{agentName}/iot_items/{name}", null)]
public class IotItem : NamedEntity, IEquatable<BaseEntity>, IHaveOwner, IHaveName

Inheritance

object

BaseEntity

DefaultEntity

NamedEntity

IotItem

Implements

IEquatable<BaseEntity>

IHaveOwner

IHaveName

Inherited Members

NamedEntity.Name

NamedEntity.AppendHashSources(CustomHashGenerator.HashSourceBuilder)

NamedEntity.GetUpdateDiff(NamedEntity, bool)

DefaultEntity.Owner

BaseEntity.IncludesNestedDynamicProperties

BaseEntity.Hash

BaseEntity.ProjectId

BaseEntity.Description

BaseEntity.TypeName

BaseEntity.DynamicProperties

BaseEntity.Equals(BaseEntity)

BaseEntity.GetDynamicProperty<T>(string)

BaseEntity.SetDynamicProperty<T>(string, T)

BaseEntity.TryGetDynamicProperty<T>(string, out T)

BaseEntity.CalculateHash()

BaseEntity.EnsureDynamicPropertiesNormalized()

BaseEntity.NormalizeNestedProperties()

BaseEntity.ConditionalNonSerialized()

BaseEntity.Cleanup(IKepwareDefaultValueProvider, bool, CancellationToken)

BaseEntity.GetUpdateDiff(DefaultEntity)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

HelperExtentions.Flatten(NamedEntity?)

HelperExtentions.Flatten(NamedEntity?, Type)

Constructors

IotItem()

Initializes a new instance of the IotItem class.

IotItem(string)

Initializes a new instance of the IotItem class with the specified name.

Properties

DataType

Gets or sets the data type of the referenced tag.

DeadbandPercent

Gets or sets the deadband percentage for publish threshold.

Enabled

Gets or sets whether the IoT Item is enabled.

PublishEveryScan

Gets or sets whether to publish on every scan regardless of value change.

ScanRateMs

Gets or sets the scan rate in milliseconds.

ServerTag

Gets or sets the full channel.device.name of the referenced server tag.

UseScanRate

Gets or sets whether to use scan rate to collect data from the device.