Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

(Please provide example in description)
Class NameDescriptionDependencies
ActionContains the target and parameters and expected responses, that describe a REST call.
AddressableThe metadata required to make a request to an EdgeX Foundry target. Example:______________For example, the Addressable could be HTTP and URL address details to reach a device service by REST and might include attributes such as HTTP Protocol, URL host of edgex-modbus-device-service, port of 49090.
AdminStateAn object's current administrative state of "Locked" or "Unlocked."
CallbackAlertThe object used by the system to alert regarding a change to a system object.
CommandThe REST description of an interface.
DeviceThe object that contains information about the state, position, reachability, and methods of interfacing with a Device.Top Level object
DeviceManagerAn object that groups other Devices and groups of Devices.
DeviceObjectThe atomic description of a particular protocol level interface for a class of Devices.
DeviceProfileThe description of both the protocol level interface, device service interface, and mapping and interpretation logic that describe communication to a class of devices.Top Level object
DeviceReport

DeviceServiceThe current state and reachability information registered for a Device Service.Top Level object
OperatingState

An object's current operating state of "Enabled" or "Disabled."


ProfilePropertyThe transformation, constraint, and unit properties for a class of Device data.
ProfileResourceThe set of operations that is executed by a Service for a particular Command.
PropertyValueThe transformation and constraint properties for a class of data.
ProvisionWatcherThe metadata used by a Service for automatically provisioning matching Devices.Top Level object
ResourceOperationAn Operation or set of Operations executed by the Device Service on a Device.
ResponseA description of a possible REST response for a Command.
ScheduleAn object defining a timer or alarm.Top Level object
ScheduleEventThe action taken by a Service when the schedule triggers.Top Level object
ServiceThe current state and reachability information registered for a Service.
UnitsThe unit metadata about a class of Device data.

...

Where to now
Page Tree
rootTechnical DocumentationEdgeX Foundry Project Wiki