Power Line DCI Commands

The DCI console allows you to check power line (PL) communication. 

This section consists of the following:

PL Repeating Console Commands

The table below describes the PL repeating console commands for the SmartServer IoT.

CommandDescription
dcxProperty

Get or set a DCXP property. 

Arguments: [-c] [-delete] [<resource>,] <property>, [value]

Arguments are delimited by comma ( , ).  Specifying a property with a comma but not a value (e.g. dcxProperty ppp username,) clears the property.

The character ( * ) denotes all instances (e.g., dcxProperty resource.Event.* ). If resource is not specified, then it defaults to the DCX node property. 

  • –c is used to create a resource
  • –delete is used to delete a resource
dcxp

Get all configuration and status properties of the DCX; display the property names. 

dcxProperty modem type

Get the DCX’s modem type.

dcxProperty modem type, 2Set the DCX’s modem type to 2.
dcxProperty ppp username,

Clear a property such as agent.

dcxProperty device.2048, state

Get the device 2048’s state.

dcxProperty device.*, state

Get the state property of all devices.

dcxProperty device.2048, disabled, false

Disable device 2048.

dcxProperty device.2048, agent,

Clear device 2048’s agent.

dcxProperty f.*, disabled, true

Set all functions to disabled.

dcxProperty device.2048

Get all configuration and status properties for device 2048.

View the property names.

dcxp device.*,Get all configuration and status properties for all devices.
dcxp –c device.33, device id, 112233445566

Create a device with handle 33 and device ID 0x112233445566.

Only set one property during a create. The rest can be set using additional dcxp requests (see above).

dcxp –delete device.33

Delete device 33.

Caution when using the -delete command

This command does not provide a prompt to confirm the delete operation. 

This command prints out the items as they are deleted. For large sets of resources, this process can be time consuming.

dcxp –delete device.*

Delete all devices.

Caution when using the -delete command

This command does not provide a prompt to confirm the delete operation. 

This command prints out the items as they are deleted. For large sets of resources, this process can be time consuming.

dcxp –delete *.*

Delete everything.

Caution when using the -delete command

This command does not provide a prompt to confirm the delete operation. 

This command prints out the items as they are deleted. For large sets of resources, this process can be time consuming.

dcxProperty resource.*List resource collections.

dcxProperty resource.*

dcxProperty resource.<resource name>*

Count a collection.

  1. Obtain a list of Resource.
  2. Count resources of a given type.

Examples:

  • dcxProperty resource.DeviceConfig.*
    • Returns the number of devices

  • dcxProperty resource.Event.*
    • Returns the number of events

  • dcxProperty resource.Operation.*
    • Returns the number of operations pending

  • dcxProperty resource.Result.*
    • Returns the number of operation results

  • dcxProperty resource.Data.*
    • Returns the number of billing data

dcxProperty resource.*

dcxProperty <resource name>.*

List resources in a collection.

  1. Obtain a list of Resource.
  2. List all resource instances by key.

Examples:

  • dcxProperty device.*
    • Lists all device keys

  • dcxProperty event.* 
    • Lists all events

  • dcxProperty eventConfig.*
    • Lists all event types

dcxProperty resource.*

dcxProperty <resource name>.*

dcxProperty <key>

List properties of a resource.

  1. Obtain a list of Resource.
  2. List all resource instances by key.
  3. Specify the key.

Examples:

  • dcxProperty eventConfig.*
    • Lists all event types

  • dcxProperty <key>
    • where <key> is listed in the above command

Arguments: [+/-commPending] [+/-up] [+/-disabled] [+/-s<states>] [+/-h#\n");

  • + requests that only qualifying devices be displayed
  • - requests that qualifying devices be excluded
  • <states> is a list of characters denoting the states to be listed (+) or suppressed (-)
  • [up], [no] agent, [co]nfirmed down, [na]scent, [wr]ong key, [in]valid neuron state, [un]known
  • +h# where # is a decimal number; selects devices with # or more hops
  • -h# where # is a decimal number; selects devices with # or less hops

Example:

dcxShowDevices

This command displays general state information for all devices device on the DC.

The default is to display all devices except DC NI.

  • dcxShowDevices +scono –h3 +h3
    • Lists Confirmed Down and No Agent devices that use exactly 3 hops


Reported Status Information

The table below describes the status information that is reported for each of the specified devices:

Status CodeDescription
NACK Code

Not used

Status

First 6 bytes of the last status reported by the device (see also Status2).

Current PhaseThe value can be Unknown, 0 (Phase R), -120 (Phase S), or +120 (Phase T).
Phase Inversion 1 specifies the phase is inverted.
Comm Attempts The number of attempts to communicate not including the use of a device as a repeater or agent. During commissioning, this value is only incremented after the SmartServer attempts to use a given agent/target pair.  It is not incremented while trying to discover viable agents.  The value for a device is cleared when the device is successfully commissioned.
Comm FailuresThe number of communication failures where a failure is a message that could not be delivered through any agent. During commissioning, this value is only incremented after the SmartServer attempts to use a given agent/target pair.  It is not incremented while trying to discover viable agents.  The value for a device is cleared when the device is successfully commissioned.
Comm Agent Switch

The number of times a message was delivered after trying an alternate agent. During commissioning, this value is incremented each time the SmartServer attempts to commission a device with a different agent.  The value for a device is cleared when the device is successfully commissioned.

Comm Skipped

The number of communication attempts that were skipped due to the destination device not being in the up state. During commissioning, this value is incremented each time the SmartServer finds an agent which can communicate with the target but rejects the agent due to invalid phase or insufficient margin.  The value for a device is cleared when the device is successfully commissioned.

Failure History A bit mask indicating the communication results for the last 24 hours, divided into 32 45-minute intervals. A 1 indicates that either at least one failure occurred during the interval, or that the device was down at the end of the interval. The LSB has the most recent result. While the SmartServer is online, the bits in the failure history are automatically shifted at the end each 45-minute interval.
Last ReadingNot used.
Function Pending

A bit array, one bit per function identifiers (LSB == function 0). For non-continuous functions, a 1 indicates the function is outstanding for this device (either has not run successfully or at all). For continuous functions, a 1 indicates that the device is enabled for the function.

AgentThe handle of the agent for the device.
Agent Primary Frequency

1 specifies the agent uses the primary frequency.

State

The device state. The values are as follows:

  • Up
  • Down (not responding)
  • Confirmed Down (not responding for duration exceeding down limit)
  • Nascent (responds to messages using unique ID addressing but not to messages using subnet/node ID addressing)
  • Wrong Key (could not commission using authentication key
  • Invalid Neuron
  • Unknown (commissioning is scheduled but has not begun on this device).  

A typical state transition for commissioning is as follows: the device is created by the SmartServer in the Up state (because it is a zero value), and then almost immediately changes to the Unknown state since it is scheduled for commissioning. When the commissioning function runs and the device does not have an assigned agent, the device is initialized into the ConfirmedDown state (if an agent is assigned then it is left in the Unknown state). When commissioning completes successfully, then the state changes to Up and the commissioning pending flag is cleared. If commissioning fails, the device is placed in ConfirmedDown (indicating no agents found or device is not reachable), Wrong Key, or Invalid Neuron state. A Down event is generated for the Wrong Key and Invalid Neuron states.

Program ID

The LON program ID.

Time Last Agent

The time an agent last reached this device.

Last Time Delta

A signed value with the last measured amount of clock error.

Last Error

 The last non-zero cause code.

Current AgentThe handle for an alternate agent. This agent may require fewer hops than the agent in the Agent. It also may reflect an agent change resulting from a temporary communication failure between the agent in the Agent property and this device. An asterisk ( ) is displayed after the current agent handle if the agent property does not match the current agent property, or if there is a non-zero recommended agent and it does not match the current agent property.
Current Agent Pri Freq1 specifies the current agent uses the primary frequency.
Inactive Phases

Bit field indicating which phases on the device are configured to be inactive. Bit 0 indicates phase A is inactive, if set; bit 1 indicates phase B is inactive, if set; bit 2 indicates phase C is inactive, if set; bit 7 indicates data is valid, if set.

Agent Log

A log with 10 entries. Each entry consists of a 16-bit agent handle, 4-bit primary signal margin, 4-bit primary signal strength, 4-bit secondary signal margin, 4-bit secondary signal strength, and a 16-bit failure history. The 10 entries are followed by a 16-bit value for the next clear time represented as seconds since 00:00:00 1-Jan-2002. 

The margin values are encoded as follows:

  • 0: -6dB (worst or failed)
  • 1: -3dB
  • 2: 0dB
  • 3: 3dB
  • 4: 6dB
  • 5: 9dB (marginal)
  • 6: 12dB
  • 7: 15dB
  • 8: 18dB
  • 9: 21dB
  • 10: 24dB
  • 11: 27dB
  • 12: 30dB
  • 13: 33dB
  • 14: 36dB
  • 15: 39dB (best)

The signal strength values are encoded as follows:

  • 0: -84dB (worst or failed)
  • 1: -78dB
  • 2: -72dB
  • 3: -66dB
  • 4: -60dB (marginal)
  • 5: -54dB (marginal)
  • 6: -48dB
  • 7: -42dB
  • 8: -36dB
  • 9: -30dB
  • 10: -24dB
  • 11: -18dB
  • 12: -12dB
  • 13: -6dB
  • 14: 0dB
  • 15: 6dB (best)
Hop Count

The number of hops required to reach the device. A hop represents a leg of transmission.  A device that is directly reachable from the SmartServer has a hop count of 1.  The SmartServer has a hop count of 0; other devices have a zero hop count only if the Agent property is zero.   The maximum value is 8 (6 repeaters and 1 agent).

Reachability Flags

Not used.

Time Last Failure

Reports the time of the most recent non-response from the device in a function other than the Find Agent or Priority Find Agent functions. Failures from Find Agent and Priority Find Agent are not tracked because they can normally occur while trying bad agents and do not reflect target failures. The time is logged whenever the device’s Comm Failure count is incremented (but may continue to be logged even if the count has stopped due to reaching the limit).

MEP Occupancy

Not used.

Status2

Last 4 bytes of the last status reported by the device (see also Status).

Auto Test Point

The value can be Not a Test Point, Automatic Test Point, Confirmed Test Point, or Removing.

HW Config

Not used.

Phase Accuracy

Indicates reliability of the phase measurement. A value of 0 indicates the best accuracy. The larger the value, the worse the accuracy.

IDI

The current IDI of the device.

Agent Margin Detail

An array with 10 entries reporting the agent margin history for this device covering 12 two hour periods (0:00-2:00, 2:00-4:00, etc). The first byte has the 0:00-2:00 value, the second the 2:00-4:00 value, and so on. Within each byte, the LSN is the primary value and the MSN is the secondary value. The margin values are encoded as described for the Agent Log. Each entry corresponds to one of the 10 entries in the Agent Log property. An Agent Log entry may not correspond to the entry in the Agent Margin Detail if you read them at different times.

Failed Function

A bit array, one bit per function identifiers. A 1 indicates that a failure occurred with this on the most recent function execution.

Serial Number

Not used.

Local Meter

Not used.

Model Number

Not used.

Download Status

Not used.

Phase Rotation

Not used.

TS Handle

Not used.

LVGM Status

A bit array reporting the status of the device relative to the currently computer topology.

Continuous Function Pending

A bit array with one bit per function identifiers (LSB == function 0). This property only applies to continuous functions and functions with an ID > 31. A 1 indicates the function is outstanding for this device (either has not run successfully or at all).

Commission Status

 A value of 0 indicates commissioning is pending; a value of 1 indicates commissioning failed; and a value of 2 indicates successful commissioning. The value is set to 0 if the device configuration is modified or the commission function is rescheduled.

Commission Timestamp

Reports the date and time the commission status was updated to success or failure. The value is set to 0 if the device configuration is modified or the commission function is rescheduled.