Versions Compared

Key

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

...

NameExamplesName ConstraintsRecommended Naming Convention
thing   
thing propertytemperature, lastTemperature, latestVoltageChangeDate
  1. only alphanumeric characters and _ (underscore)

Excerpt Include
Constraint - thing property name
Constraint - thing property name
nopaneltrue

Name provides information about content of property: <subject>
thing methodgetTemperature, getNumberOfProcessors
  1.  only alphanumeric characters and _ (underscore)

Excerpt Include
Constraint - thing method name
Constraint - thing method name
nopaneltrue

Name of method consists of action and subject, like <action><Subject>
thing eventtemperatureChanged, motionDetected
  1. only alphanumeric characters and _ (underscore)

Excerpt Include
Constraint - thing event name
Constraint - thing event name
nopaneltrue

Name looks like <value><Action (VERB+ed, irreg. VERB)>
thing triggersendAlertOnTemperatureChanged, alarmOnMotionDetected, onTemperatureChanged
  1. only alphanumeric characters and _ (underscore)

Excerpt Include
Constraint - thing trigger name
Constraint - thing trigger name
nopaneltrue

Name looks like <action><On><Event>, or <on><Event> in case of single trigger for the same event
thing schedulechangeTemperature, changeTemperatureHourly, computeValue, computeValueDaily
  1. only alphanumeric characters and _ (underscore)

Excerpt Include
Constraint - thing schedule name
Constraint - thing schedule name
nopaneltrue

Name looks like <action><Optional Details><Optional Timing Details>
thing connectionmqtt, tcp, tcpPort80

 

  1. only alphanumeric characters and _ (underscore)

Excerpt Include
Constraint - thing connection name
Constraint - thing connection name
nopaneltrue

Name looks like <protocol><Optional Specs>
template   
template version   
product   
product serial number12ABC, 12-34-56, 1234ab
  1. only alphanumeric characters, _ (underscore) and - (minus)
 
structure data typeHddInformation, TemperatureStatistics, Location
  1. alphanumeric
  2. start with a capital letter
 
structure data type attributelongitude, numberOfProcessors
  1. only alphanumeric characters and _ (underscore)

Excerpt Include
Constraint - structure data type attribute name
Constraint - structure data type attribute name
nopaneltrue

Name provides information about attribute subject: <subject>
data type packagecom.mypackage.util, org.m2m.device, com.gadgetkeeper.service
  1. start with a letter
  2. only alphanumeric characters and .(dot) as a package delimiter
  3. all lower case

it's advised for companies to use their reversed Internet domain name to begin their package names - for example, com.example.mypackage for a package named mypackage created by a programmer at example.com.