Common and network

Point names are the ones records use; [*] stands for a repeating group's index. See Supported SunSpec models for every group.

ModelName in recordsPoints
1common6
2aggregator10
3model_358
4model_460
5model_588
6model_689
7model_79
8model_83
9model_992
10model_103
11model_117
12model_1215
13model_1315
14model_148
15model_1512
16model_1610
17model_178
18model_185
19model_199

Model 1: Common

Name in records: common.

All SunSpec compliant devices must include this as the first model

PointTypeUnitsLabelDescription
MnstringManufacturerWell known value registered with SunSpec for compliance
MdstringModelManufacturer specific value (32 chars)
OptstringOptionsManufacturer specific value (16 chars)
VrstringVersionManufacturer specific value (16 chars)
SNstringSerial NumberManufacturer specific value (32 chars)
DAuint16Device AddressModbus device address

Model 2: Basic Aggregator

Name in records: aggregator.

Aggregates a collection of models for a given model id

PointTypeUnitsLabelDescription
AIDuint16AIDAggregated model id
Nuint16NNumber of aggregated models
UNuint16UNUpdate Number. Incrementing number each time the mapping is changed. If the number is not changed from the last reading the direct access to a specific offset will result in reading the same logical model as before. Otherwise the entire model must be read to refresh the changes
Stenum16StatusEnumerated status code
StVndenum16Vendor StatusVendor specific status code
Evtbitfield32Event CodeBitmask event code
EvtVndbitfield32Vendor Event CodeVendor specific event code
Ctlenum16ControlControl register for all aggregated devices
CtlVndenum32Vendor ControlVendor control register for all aggregated devices
CtlVlenum32Control ValueNumerical value used as a parameter to the control

Value names:

  • St (enum16): 1 OFF, 2 ON, 3 FULL, 4 FAULT
  • Evt (bitfield32): bit 0 GROUND_FAULT, bit 1 INPUT_OVER_VOLTAGE, bit 2 RESERVED_2, bit 3 DC_DISCONNECT, bit 4 RESERVED_4, bit 5 RESERVED_5, bit 6 MANUAL_SHUTDOWN, bit 7 OVER_TEMPERATURE, bit 8 RESERVED_8, bit 9 RESERVED_9, bit 10 RESERVED_10, bit 11 RESERVED_11, bit 12 BLOWN_FUSE, bit 13 UNDER_TEMPERATURE, bit 14 MEMORY_LOSS, bit 15 ARC_DETECTION, bit 16 THEFT_DETECTION, bit 17 OUTPUT_OVER_CURRENT, bit 18 OUTPUT_OVER_VOLTAGE, bit 19 OUTPUT_UNDER_VOLTAGE, bit 20 TEST_FAILED
  • Ctl (enum16): 0 NONE, 1 AUTOMATIC, 2 FORCE_OFF, 3 TEST, 4 THROTTLE

Model 3: Secure Dataset Read Request

Name in records: model_3.

Request a digital signature over a specified set of data registers

PointTypeUnitsLabelDescription
Xuint16XNumber of registers being requested
Off1uint16Offset1Offset of value to read
Off2uint16
Off3uint16
Off4uint16
Off5uint16
Off6uint16
Off7uint16
Off8uint16
Off9uint16
Off10uint16
Off11uint16
Off12uint16
Off13uint16
Off14uint16
Off15uint16
Off16uint16
Off17uint16
Off18uint16
Off19uint16
Off20uint16
Off21uint16
Off22uint16
Off23uint16
Off24uint16
Off25uint16
Off26uint16
Off27uint16
Off28uint16
Off29uint16
Off30uint16
Off31uint16
Off32uint16
Off33uint16
Off34uint16
Off35uint16
Off36uint16
Off37uint16
Off38uint16
Off39uint16
Off40uint16
Off41uint16
Off42uint16
Off43uint16
Off44uint16
Off45uint16
Off46uint16
Off47uint16
Off48uint16
Off49uint16
Off50uint16
Tsuint32TimestampTimestamp value is the number of seconds since January 1, 2000
Msuint16MillisecondsMillisecond counter 0-999
Sequint16SequenceSequence number of request
Roleuint16RoleDigital Signature ID
Algenum16AlgorithmAlgorithm used to compute the digital signature
Nuint16NNumber of registers comprising the digital signature.
repeating[*].DSuint16DSDigital Signature

Value names:

  • Alg (enum16): 0 NONE, 1 AES-GMAC-64, 2 ECC-256

Model 4: Secure Dataset Read Response

Name in records: model_4.

Compute a digital signature over a specified set of data registers

PointTypeUnitsLabelDescription
RqSequint16Request SequenceSequence number from the request
Stsenum16StatusStatus of last read operation
Xuint16XNumber of values from the request
Val1uint16Value1Copy of value from register Off1.
Val2uint16
Val3uint16
Val4uint16
Val5uint16
Val6uint16
Val7uint16
Val8uint16
Val9uint16
Val10uint16
Val11uint16
Val12uint16
Val13uint16
Val14uint16
Val15uint16
Val16uint16
Val17uint16
Val18uint16
Val19uint16
Val20uint16
Val21uint16
Val22uint16
Val23uint16
Val24uint16
Val25uint16
Val26uint16
Val27uint16
Val28uint16
Val29uint16
Val30uint16
Val31uint16
Val32uint16
Val33uint16
Val34uint16
Val35uint16
Val36uint16
Val37uint16
Val38uint16
Val39uint16
Val40uint16
Val41uint16
Val42uint16
Val43uint16
Val44uint16
Val45uint16
Val46uint16
Val47uint16
Val48uint16
Val49uint16
Val50uint16
Tsuint32TimestampTimestamp value is the number of seconds since January 1, 2000
Msuint16MillisecondsMillisecond counter 0-999
Sequint16SequenceSequence number of response
Almenum16AlarmBitmask alarm code
Algenum16AlgorithmAlgorithm used to compute the digital signature
Nuint16NNumber of registers comprising the digital signature.
repeating[*].DSuint16DSDigital Signature

Value names:

  • Sts (enum16): 0 SUCCESS, 1 DS, 2 ACL, 3 OFF
  • Alm (enum16): 0 NONE, 1 ALM
  • Alg (enum16): 0 NONE, 1 AES-GMAC-64, 2 ECC-256

Model 5: Secure Write Request

Name in records: model_5.

Include a digital signature along with the control data

PointTypeUnitsLabelDescription
Xuint16XNumber of (offset, value) pairs being written
Off1uint16Offset1Offset of control register to write value to
Val1uint16Value1Value to write to control register at offset
Off2uint16
Val2uint16
Off3uint16
Val3uint16
Off4uint16
Val4uint16
Off5uint16
Val5uint16
Off6uint16
Val6uint16
Off7uint16
Val7uint16
Off8uint16
Val8uint16
Off9uint16
Val9uint16
Off10uint16
Val10uint16
Off11uint16
Val11uint16
Off12uint16
Val12uint16
Off13uint16
Val13uint16
Off14uint16
Val14uint16
Off15uint16
Val15uint16
Off16uint16
Val16uint16
Off17uint16
Val17uint16
Off18uint16
Val18uint16
Off19uint16
Val19uint16
Off20uint16
Val20uint16
Off21uint16
Val21uint16
Off22uint16
Val22uint16
Off23uint16
Val23uint16
Off24uint16
Val24uint16
Off25uint16
Val25uint16
Off26uint16
Val26uint16
Off27uint16
Val27uint16
Off28uint16
Val28uint16
Off29uint16
Val29uint16
Off30uint16
Val30uint16
Off31uint16
Val31uint16
Off32uint16
Val32uint16
Off33uint16
Val33uint16
Off34uint16
Val34uint16
Off35uint16
Val35uint16
Off36uint16
Val36uint16
Off37uint16
Val37uint16
Off38uint16
Val38uint16
Off39uint16
Val39uint16
Off40uint16
Val40uint16
Tsuint32TimestampTimestamp value is the number of seconds since January 1, 2000
Msuint16MillisecondsMillisecond counter 0-999
Sequint16SequenceSequence number of request
Roleuint16RoleSigning key used 0-5
Algenum16AlgorithmAlgorithm used to compute the digital signature
Nuint16NNumber of registers comprising the digital signature.
repeating[*].DSuint16DSDigital Signature

Value names:

  • Alg (enum16): 0 NONE, 1 AES-GMAC-64, 2 ECC-256

Model 6: Secure Write Sequential Request

Name in records: model_6.

Include a digital signature along with the control data

PointTypeUnitsLabelDescription
Xuint16XNumber of (offset, value) pairs being written
Offuint16OffsetStarting offset for write operation
Val1uint16Value1Value to write to control register at offset
Val2uint16
Val3uint16
Val4uint16
Val5uint16
Val6uint16
Val7uint16
Val8uint16
Val9uint16
Val10uint16
Val11uint16
Val12uint16
Val13uint16
Val14uint16
Val15uint16
Val16uint16
Val17uint16
Val18uint16
Val19uint16
Val20uint16
Val21uint16
Val22uint16
Val23uint16
Val24uint16
Val25uint16
Val26uint16
Val27uint16
Val28uint16
Val29uint16
Val30uint16
Val31uint16
Val32uint16
Val33uint16
Val34uint16
Val35uint16
Val36uint16
Val37uint16
Val38uint16
Val39uint16
Val40uint16
Val41uint16
Val42uint16
Val43uint16
Val44uint16
Val45uint16
Val46uint16
Val47uint16
Val48uint16
Val49uint16
Val50uint16
Val51uint16
Val52uint16
Val53uint16
Val54uint16
Val55uint16
Val56uint16
Val57uint16
Val58uint16
Val59uint16
Val60uint16
Val61uint16
Val62uint16
Val63uint16
Val64uint16
Val65uint16
Val66uint16
Val67uint16
Val68uint16
Val69uint16
Val70uint16
Val71uint16
Val72uint16
Val73uint16
Val74uint16
Val75uint16
Val76uint16
Val77uint16
Val78uint16
Val79uint16
Val80uint16
Tsuint32TimestampTimestamp value is the number of seconds since January 1, 2000
Msuint16MillisecondsMillisecond counter 0-999
Sequint16SequenceSequence number of request
Roleuint16RoleSigning key used 0-5
Algenum16AlgorithmAlgorithm used to compute the digital signature
Nuint16NNumber of registers comprising the digital signature.
repeating[*].DSuint16DSDigital Signature

Value names:

  • Alg (enum16): 0 NONE, 1 AES-GMAC-64, 2 ECC-256

Model 7: Secure Write Response Model (DRAFT 1)

Name in records: model_7.

Include a digital signature over the response

PointTypeUnitsLabelDescription
RqSequint16Request SequenceSequence number from the request
Stsenum16StatusStatus of last write operation
Tsuint32TimestampTimestamp value is the number of seconds since January 1, 2000
Msuint16MillisecondsMillisecond counter 0-999
Sequint16SequenceSequence number of response
Almenum16AlarmBitmask alarm code
Algenum16AlgorithmAlgorithm used to compute the digital signature
Nuint16NNumber of registers comprising the digital signature.
repeating[*].DSuint16DSDigital Signature

Value names:

  • Sts (enum16): 0 SUCCESS, 1 DS, 2 ACL, 3 OFF, 4 VAL
  • Alm (enum16): 0 NONE, 1 ALM
  • Alg (enum16): 0 NONE, 1 AES-GMAC-64, 2 ECC-256

Model 8: Get Device Security Certificate

Name in records: model_8.

Security model for PKI

PointTypeUnitsLabelDescription
Fmtenum16FormatX.509 format of the certificate. DER or PEM.
Nuint16NNumber of registers to follow for the certificate
repeating[*].Certuint16CertX.509 Certificate of the device

Value names:

  • Fmt (enum16): 0 NONE, 1 X509_PEM, 2 X509_DER

Model 9: Set Operator Security Certificate

Name in records: model_9.

Security model for PKI

PointTypeUnitsLabelDescription
CertUIDuint16Cert_UIDUser ID for this certificate
CertRoleuint16Cert_RoleRole for this certificate
Fmtenum16FormatFormat of this certificate
Typenum16TypeType of this certificate
TotLnuint16Total LengthTotal Length of the Certificate
FrgLnuint16Fragment lengthLength of this fragment
Frg1uint16Frag1First word of this fragment
Frg2uint16
Frg3uint16
Frg4uint16
Frg5uint16
Frg6uint16
Frg7uint16
Frg8uint16
Frg9uint16
Frg10uint16
Frg11uint16
Frg12uint16
Frg13uint16
Frg14uint16
Frg15uint16
Frg16uint16
Frg17uint16
Frg18uint16
Frg19uint16
Frg20uint16
Frg21uint16
Frg22uint16
Frg23uint16
Frg24uint16
Frg25uint16
Frg26uint16
Frg27uint16
Frg28uint16
Frg29uint16
Frg30uint16
Frg31uint16
Frg32uint16
Frg33uint16
Frg34uint16
Frg35uint16
Frg36uint16
Frg37uint16
Frg38uint16
Frg39uint16
Frg40uint16
Frg41uint16
Frg42uint16
Frg43uint16
Frg44uint16
Frg45uint16
Frg46uint16
Frg47uint16
Frg48uint16
Frg49uint16
Frg50uint16
Frg51uint16
Frg52uint16
Frg53uint16
Frg54uint16
Frg55uint16
Frg56uint16
Frg57uint16
Frg58uint16
Frg59uint16
Frg60uint16
Frg61uint16
Frg62uint16
Frg63uint16
Frg64uint16
Frg65uint16
Frg66uint16
Frg67uint16
Frg68uint16
Frg69uint16
Frg70uint16
Frg71uint16
Frg72uint16
Frg73uint16
Frg74uint16
Frg75uint16
Frg78uint16
Frg79uint16
Frg80uint16Frag80Last word of this fragment
Tsuint32TimestampTimestamp value is the number of seconds since January 1, 2000
Msuint16MillisecondsMillisecond counter 0-999
Sequint16SequenceSequence number of request
UIDuint16UIDUser ID for the request signature
Roleuint16RoleSigning key used 0-5
Algenum16AlgorithmAlgorithm used to compute the digital signature
Nuint16NNumber of registers to follow for the certificate
repeating[*].Certuint16

Value names:

  • Fmt (enum16): 0 NONE, 1 X509_PEM, 2 X509_DER
  • Typ (enum16): 0 DEV_KEY_PAIR, 1 DEV_SHARED_KEY, 2 OPERATOR_PUB, 3 OPERATOR_SHARED, 4 CA_PUB
  • Alg (enum16): 0 NONE, 1 AES-GMAC-64, 2 ECC-256

Model 10: Communication Interface Header

Name in records: model_10.

To be included first for a complete interface description

PointTypeUnitsLabelDescription
Stenum16Interface StatusOverall interface status
Ctluint16Interface ControlOverall interface control (TBD)
Typenum16Physical Access TypeType of physical media

Value names:

  • St (enum16): 0 DOWN, 1 UP, 2 FAULT
  • Typ (enum16): 0 UNKNOWN, 1 INTERNAL, 2 TWISTED_PAIR, 3 FIBER, 4 WIRELESS

Name in records: model_11.

Include to support a wired ethernet port

PointTypeUnitsLabelDescription
Spduint16MbpsEthernet Link SpeedInterface speed in Mb/s
CfgStbitfield16Interface Status FlagsInterface flags.
Stenum16Link StateState information for this interface
MACeui48MACIEEE MAC address of this interface
NamstringNameInterface name (8 chars)
Ctlbitfield16ControlControl flags
FrcSpduint16MbpsForced SpeedForced interface speed in Mb/s when AUTO is disabled

Value names:

  • CfgSt (bitfield16): bit 0 LINK, bit 1 FULL_DUPLEX, bit 2 AUTO_NEG1, bit 3 AUTO_NEG2, bit 4 AUTO_NEG3, bit 5 RESET_REQUIRED, bit 6 HW_FAULT
  • St (enum16): 0 UNKNOWN, 1 ENABLED, 2 DISABLED, 3 TESTING
  • Ctl (bitfield16): bit 0 AUTO, bit 1 FULL_DUPLEX

Model 12: IPv4

Name in records: model_12.

Include to support an IPv4 protocol stack on this interface

PointTypeUnitsLabelDescription
NamstringNameInterface name
CfgStenum16Config StatusConfiguration status
ChgStbitfield16Change StatusA configuration change is pending
Capbitfield16Config CapabilityIdentify capable sources of configuration
Cfgenum16IPv4 ConfigConfiguration method used.
Ctlenum16ControlConfigure use of services
AddrstringIPIPv4 numeric address as a dotted string xxx.xxx.xxx.xxx
MskstringNetmaskIPv4 numeric netmask as a dotted string xxx.xxx.xxx.xxx
GwstringGatewayIPv4 numeric gateway address as a dotted string xxx.xxx.xxx.xxx
DNS1stringDNS1IPv4 numeric DNS address as a dotted string xxx.xxx.xxx.xxx
DNS2stringDNS2IPv4 numeric DNS address as a dotted string xxx.xxx.xxx.xxx
NTP1stringNTP1IPv4 numeric NTP address as a dotted string xxx.xxx.xxx.xxx
NTP2stringNTP2IPv4 numeric NTP address as a dotted string xxx.xxx.xxx.xxx
DomNamstringDomainDomain name (24 chars max)
HostNamstringHost NameHost name (24 chars max)

Value names:

  • CfgSt (enum16): 0 NOT_CONFIGURED, 1 VALID_SETTING, 2 VALID_HW
  • ChgSt (bitfield16): bit 0 PENDING
  • Cap (bitfield16): bit 0 DHCP, bit 1 BOOTP, bit 2 ZEROCONF, bit 3 DNS, bit 4 CFG_SETTABLE, bit 5 HW_CONFIG, bit 6 NTP_CLIENT, bit 7 RESET_REQUIRED
  • Cfg (enum16): 0 STATIC, 1 DHCP, 2 BOOTP, 3 ZEROCONF
  • Ctl (enum16): 0 ENABLE_DNS, 1 ENABLE_NTP

Model 13: IPv6

Name in records: model_13.

Include to support an IPv6 protocol stack on this interface

PointTypeUnitsLabelDescription
NamstringNameInterface name
CfgStenum16Config StatusConfiguration status
ChgStbitfield16Change StatusA configuration change is pending
Capbitfield16Config CapabilityIdentify capable sources of configuration
Cfgenum16IPv6 ConfigConfiguration method used.
Ctlenum16ControlConfigure use of services
AddrstringIPIPv6 numeric address as a dotted string xxxx.xxxx.xxxx.xxxx
CIDRstringCIDRClassless Inter-Domain Routing Number
GwstringGatewayIPv6 numeric address as a dotted string xxxx.xxxx.xxxx.xxxx
DNS1stringDNS1IPv6 numeric DNS address as a dotted string xxxx.xxxx.xxxx.xxxx
DNS2stringDNS2IPv6 numeric DNS address as a dotted string xxxx.xxxx.xxxx.xxxx
NTP1stringNTP1IPv6 numeric NTP address as a name or dotted string xxxx.xxxx.xxxx.xxxx
NTP2stringNTP2IPv6 numeric NTP address as a name or dotted string xxxx.xxxx.xxxx.xxxx
DomNamstringDomainDomain name (24 chars max)
HostNamstringHost NameHost name (24 chars max)

Value names:

  • CfgSt (enum16): 0 NOT_CONFIGURED, 1 VALID_SETTING, 2 VALID_HW
  • ChgSt (bitfield16): bit 0 PENDING
  • Cap (bitfield16): bit 0 DHCP, bit 1 BOOTP, bit 2 ZEROCONF, bit 3 DNS, bit 4 CFG_SETTABLE, bit 5 HW_CONFIG, bit 6 NTP_CLIENT, bit 7 RESET_REQUIRED
  • Cfg (enum16): 0 STATIC, 1 DHCP, 2 BOOTP, 3 ZEROCONF
  • Ctl (enum16): 0 ENABLE_DNS, 1 ENABLE_NTP

Model 14: Proxy Server

Name in records: model_14.

Include this block to allow for a proxy server

PointTypeUnitsLabelDescription
NamstringnameInterface name (8 chars)
Capbitfield16CapabilitiesProxy configuration capabilities
Cfgenum16ConfigSet proxy address type
Typbitfield16TypeEnumerate value. Proxy server type
AddrstringAddressIPv4 or IPv6 proxy hostname or dotted address (40 chars)
Portuint16PortProxy port number
UserstringUsernameProxy user name
PwstringPasswordProxy password

Value names:

  • Cap (bitfield16): bit 0 NO_PROXY, bit 1 IPV4_PROXY, bit 2 IPV6_PROXY

Model 15: Interface Counters Model

Name in records: model_15.

Interface counters

PointTypeUnitsLabelDescription
Clruint16ClearWrite a "1" to clear all counters
InCntacc32Input CountNumber of bytes received
InUcCntacc32Input Unicast CountNumber of Unicast packets received
InNUcCntacc32Input Non-Unicast CountNumber of non-Unicast packets received
InDscCntacc32Input Discarded CountNumber of inbound packets received on the interface but discarded
InErrCntacc32Input Error CountNumber of inbound packets that contain errors (excluding discards)
InUnkCntacc32Input Unknown CountNumber of inbound packets with unknown protocol
OutCntacc32Output CountTotal number of bytes transmitted on this interface
OutUcCntacc32Output Unicast CountNumber of Unicast packets transmitted
OutNUcCntacc32Output Non-Unicast CountNumber of Non-Unicast packets transmitted
OutDscCntacc32Output Discarded CountNumber of Discarded output packets
OutErrCntacc32Output Error CountNumber of outbound error packets

Model 16: Simple IP Network

Name in records: model_16.

Include this model for a simple IPv4 network stack

PointTypeUnitsLabelDescription
NamstringNameInterface name. (8 chars)
Cfgenum16ConfigForce IPv4 configuration method
Ctlbitfield16ControlConfigure use of services
AddrstringAddressIP address
MskstringNetmaskNetmask
GwstringGatewayGateway IP address
DNS1stringDNS132 bit IP address of DNS server
DNS2stringDNS232 bit IP address of DNS server
MACeui48MACIEEE MAC address of this interface
LnkCtlbitfield16Link ControlLink control flags

Value names:

  • Cfg (enum16): 0 STATIC, 1 DHCP
  • Ctl (bitfield16): bit 0 ENABLE_DNS, bit 1 ENABLE_NTP
  • LnkCtl (bitfield16): bit 0 AUTONEGOTIATE, bit 1 FULL_DUPLEX, bit 2 FORCE_10MB, bit 3 FORCE_100MB, bit 4 FORCE_1GB

Model 17: Serial Interface

Name in records: model_17.

Include this model for serial interface configuration support

PointTypeUnitsLabelDescription
NamstringNameInterface name (8 chars)
Rteuint32bpsRateInterface baud rate in bits per second
Bitsuint16BitsNumber of data bits per character
Ptyenum16ParityParity setting
Dupenum16DuplexDuplex mode
Flwenum16Flow ControlFlow Control Method
Typenum16Interface TypeInterface type
Pcolenum16ProtocolSerial protocol selection

Value names:

  • Pty (enum16): 0 NONE, 1 ODD, 2 EVEN
  • Dup (enum16): 0 FULL, 1 HALF
  • Flw (enum16): 0 NONE, 1 HW, 2 XONXOFF
  • Typ (enum16): 0 UNKNOWN, 1 RS232, 2 RS485
  • Pcol (enum16): 0 UNKNOWN, 1 MODBUS, 2 VENDOR

Name in records: model_18.

Include this model to support a cellular interface link

PointTypeUnitsLabelDescription
NamstringNameInterface name
IMEIuint32IMEIInternational Mobile Equipment Identifier for the interface
APNstringAPNAccess Point Name for the interface
NumstringNumberPhone number for the interface
PinstringPINPersonal Identification Number for the interface

Name in records: model_19.

Include this model to configure a Point-to-Point Protocol link

PointTypeUnitsLabelDescription
NamstringNameInterface name
Rteuint32bpsRateInterface baud rate in bits per second
Bitsuint16BitsNumber of data bits per character
Ptyenum16ParityParity setting
Dupenum16DuplexDuplex mode
Flwenum16Flow ControlFlow Control Method
Authenum16AuthenticationAuthentication method
UsrNamstringUsernameUsername for authentication
PwstringPasswordPassword for authentication

Value names:

  • Pty (enum16): 0 NONE, 1 ODD, 2 EVEN
  • Dup (enum16): 0 FULL, 1 HALF
  • Flw (enum16): 0 NONE, 1 HW, 2 XONXOFF
  • Auth (enum16): 0 NONE, 1 PAP, 2 CHAP