Classes
- AggregateDatum
- Aggregation
- AuthTokenStatus
- AuthTokenType
- CombiningType
- Datum
- DatumAuxiliaryType
- DatumFilter
- DatumReadingType
- DatumSamplesType
- DatumStreamMetadata
- DatumStreamType
- DeviceOperatingState
- GeneralMetadata
- InstructionState
- Location
- LocationPrecision
- Pagination
- SecurityPolicy
- SecurityPolicyBuilder
- SkyCondition
- SortDescriptor
- StreamAggregateDatum
- StreamDatum
- UserMetadataFilter
Mixins
Members
-
<inner, constant> Aggregations :module:domain~Aggregation
-
The enumeration of supported Aggregation values.
Type:
Properties:
Name Type Description Minute
module:domain~Aggregation minute
FiveMinute
module:domain~Aggregation 5 minutes
TenMinute
module:domain~Aggregation 10 minutes
FifeteenMinute
module:domain~Aggregation 15 minutes
ThirtyMinute
module:domain~Aggregation 30 minutes
Hour
module:domain~Aggregation an hour
HourOfDay
module:domain~Aggregation an hour of a day, e.g. 1-24
SeasonalHourOfDay
module:domain~Aggregation an hour of a day, further grouped into 4 seasons
Day
module:domain~Aggregation a day
DayOfWeek
module:domain~Aggregation a day of the week, e.g. Monday - Sunday
SeasonalDayOfWeek
module:domain~Aggregation a day of the week, further grouped into 4 seasons
Week
module:domain~Aggregation a week
WeekOfYear
module:domain~Aggregation the week within a year, e.g. 1 - 52
Month
module:domain~Aggregation a month
Year
module:domain~Aggregation a year
RunningTotal
module:domain~Aggregation a complete running total over a time span
-
<inner, constant> AuthTokenStatuses :module:domain~AuthTokenStatus
-
The enumeration of supported AuthTokenStatus values.
Type:
Properties:
Name Type Description Active
module:domain~AuthTokenStatus the token is active and usable
Disabled
module:domain~AuthTokenStatus the token is disabled and not usable
-
<inner, constant> AuthTokenTypes :module:domain~AuthTokenType
-
The enumeration of supported AuthTokenType values.
Type:
Properties:
Name Type Description ReadNodeData
module:domain~AuthTokenType a read-only token for reading SolarNode data
User
module:domain~AuthTokenType full access as the user that owns the token
-
<inner, constant> CombiningTypes :module:domain~CombiningType
-
The enumeration of supported CombiningType values.
Type:
Properties:
Name Type Description Average
module:domain~CombiningType average
Difference
module:domain~CombiningType difference; note the order of mapped IDs is significant
Sum
module:domain~CombiningType sum
-
<inner, constant> DatumAuxiliaryTypes :module:domain~DatumAuxiliaryType
-
The enumeration of supported DatumAuxiliaryType values.
Type:
Properties:
Name Type Description Reset
module:domain~DatumAuxiliaryType reset
-
<inner, constant> DatumReadingTypes :module:domain~DatumReadingType
-
The enumeration of supported
DatumReadingType
values.Type:
Properties:
Name Type Description CalculatedAt
module:domain~DatumReadingType Derive a single reading value based from one datum the nearest before a specific time and one the nearest after.
CalculatedAtDifference
module:domain~DatumReadingType Calculate the difference between two reading values on two dates, using the
CalcualtedAt
style of deriving the start and end readings.Difference
module:domain~DatumReadingType Find the difference between two datum that are nearest in time on or before two dates, without any limits on how near to those dates the datum are.
DifferenceWithin
module:domain~DatumReadingType Find the difference between two datum that are nearest in time and within two dates.
NearestDifference
module:domain~DatumReadingType Find the difference between two datum that are nearest in time on or before two dates, constrained by a maximum time tolerance.
-
<inner, constant> DatumSamplesTypes :module:domain~DatumSamplesType
-
The enumeration of supported
DatumSamplesType
values.Type:
Properties:
Name Type Description Instantaneous
module:domain~DatumSamplesType Instantaneous number property values.
Accumulating
module:domain~DatumSamplesType Accumulating meter-style number property values.
Status
module:domain~DatumSamplesType String status property values.
Tag
module:domain~DatumSamplesType Arbitrary string names.
-
<inner, constant> DatumStreamType :module:domain~DatumStreamType
-
The enumeration of supported
DatumStreamType
values.Type:
Properties:
Name Type Description Node
module:domain~DatumStreamType A node-based datum stream.
Location
module:domain~DatumStreamType A location-based datum stream.
-
<inner, constant> DeviceOperatingStates :module:domain~DeviceOperatingState
-
The enumeration of supported DeviceOperatingState values.
Type:
Properties:
Name Type Description Unknown
module:domain~DeviceOperatingState an unknown state
Normal
module:domain~DeviceOperatingState normal operating state
Starting
module:domain~DeviceOperatingState a startup/initializing state
Standby
module:domain~DeviceOperatingState a standby/low power mode
Shutdown
module:domain~DeviceOperatingState a shutdown/off state
Fault
module:domain~DeviceOperatingState a faulty or error condition
Disabled
module:domain~DeviceOperatingState a disabled state
Recovery
module:domain~DeviceOperatingState a recovery state
Override
module:domain~DeviceOperatingState a manual or overridden state
-
<inner, constant> InstructionStates :module:domain~InstructionState
-
The enumeration of supported InstructionState values.
Type:
Properties:
Name Type Description Unknown
module:domain~InstructionState an unknown state
Queued
module:domain~InstructionState the instruction has been received by SolarNet but not yet delivered to its destination
Received
module:domain~InstructionState the instruction has been delivered to its destination but not yet acted upon
Executed
module:domain~InstructionState the instruction is currently being acted upon
Declined
module:domain~InstructionState the destination has declined to execute the instruction, or the execution failed
Completed
module:domain~InstructionState the destination has executed successfully
-
<inner, constant> LocationPrecisions :module:domain~LocationPrecision
-
The enumeration of supported LocationPrecision values.
Type:
Properties:
Name Type Description LatLong
module:domain~LocationPrecision GPS coordinates
Block
module:domain~LocationPrecision a city block
Street
module:domain~LocationPrecision a street
PostalCode
module:domain~LocationPrecision a postal code (or "zip code")
Locality
module:domain~LocationPrecision a town or city
StateOrProvince
module:domain~LocationPrecision a state or province
Region
module:domain~LocationPrecision a large region
TimeZone
module:domain~LocationPrecision a time zone
Country
module:domain~LocationPrecision a country
-
<inner, constant> SkyConditions :module:domain~SkyCondition
-
The enumeration of supported SkyCondition values.
Type:
Properties:
Name Type Description Clear
module:domain~SkyCondition clear sky
ScatteredClouds
module:domain~SkyCondition scattered/few clouds
Fog
module:domain~SkyCondition fog
Drizzle
module:domain~SkyCondition drizzle, light rain
ScatteredShowers
module:domain~SkyCondition scattered/few showers
Showers
module:domain~SkyCondition showers, light rain
Rain
module:domain~SkyCondition rain
Hail
module:domain~SkyCondition hail
ScatteredSnow
module:domain~SkyCondition scattered/light snow
Snow
module:domain~SkyCondition snow
Storm
module:domain~SkyCondition storm
SevereStorm
module:domain~SkyCondition severe storm
Thunder
module:domain~SkyCondition thunder, lightning
Windy
module:domain~SkyCondition windy
Hazy
module:domain~SkyCondition hazy
Tornado
module:domain~SkyCondition tornado
Hurricane
module:domain~SkyCondition hurrican
Dusty
module:domain~SkyCondition dusty
Methods
-
<inner> objectToStringMap(obj)
-
Convert a simple object into a
Map
instance.Property values that are themselves objects will be converted into
Map
instances as well.Parameters:
Name Type Description obj
object a simple object
- See:
-
- module:domain~stringMapToObject for the reverse conversion
Returns:
a Map with string keys; nested Map objects are also handled
- Type
- Map.<string, *>
-
<inner> stringMapToObject(strMap)
-
Convert a
Map
into a simple object.The keys are assumed to be strings. Values that are themselves
Map
instances will be converted to simple objects as well.Parameters:
Name Type Description strMap
Map.<string, *> a Map with string keys; nested Map objects are also handled
- See:
-
- objectToStringMap for the reverse conversion
Returns:
a simple object
- Type
- object