Github user dlaboss commented on a diff in the pull request:
https://github.com/apache/incubator-edgent/pull/280#discussion_r99207767
--- Diff:
connectors/iot/src/main/java/org/apache/edgent/connectors/iot/IotDevice.java ---
@@ -29,13 +29,43 @@ Licensed to the Apache Software Foundation (ASF) under
one
/**
* Generic Internet of Things device connector.
+ * <p>
+ * IotDevice characteristics:
+ * <ul>
+ * <li>{@code IotDevice.getDeviceTypeId()} returns an opaque value whose
form
+ * is the domain of an IoT connector implementation.</li>
+ * <li>{@code IotDevice.getDeviceId()} returns an opaque value whose form
+ * is the domain of an IoT connector implementation.
+ * The value is unique for a particular a logical device.
+ * <li>{@code IotDevice.equals()} returns true if two IotDevice instances
are
+ * for the same logical device, false otherwise.</li>
+ * <li>{@code IotDevice.hashCode()} returns the same value for all
IotDevice instances
+ * for the same logical device.</li>
+ * <li>{@code IotDevice} may be used as a {@link
org.apache.edgent.topology.TWindow TWindow} partition key.</li>
--- End diff --
Relates to the use of an IotDevice instance as an API object representing
an IoT device. More on that in the response to your other usage model question.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
