ZigBeeNet

The Continuous Delivery (CD) process automatically determines the version of the published NuGet packages based on the tag_name used in the GitHub Release.

For example, if you create a release with the tag v1.5.0, the resulting NuGet packages will be versioned as 1.5.0.

ZigBeeNet is modular. Depending on your hardware and requirements, you will need to install the core library along with specific transport and hardware implementation packages.

Core and Transport:

• ZigBeeNet: The core Zigbee 3.0 Cluster Library implementation.
• ZigBeeNet.Transport.SerialPort: Platform-independent SerialPort implementation.

Hardware Implementations:

• ZigBeeNet.Hardware.TI.CC2531: For Texas Instruments CC25XX dongles.
• ZigBeeNet.Hardware.Digi.XBee: For Digi XBee dongles.
• ZigbeeNet.Hardware.ConBee: For Dresden Elektronik ConBee dongles.
• ZigbeeNet.Hardware.Ember: For Silicon Labs Ember dongles.

Data Storage:

• ZigbeeNet.DataStore.JSON: JSON-based data storage.
• ZigbeeNet.DataStore.MongoDb: MongoDB-based data storage.

ZigBeeNet uses GitHub Actions for Continuous Integration (CI) and Continuous Delivery (CD).

• CI (Continuous Integration): Triggered by a push to a branch or a pull request to the develop or master branches. It uses dotnet command-line tooling to perform build steps.
• CD (Continuous Delivery): Triggered by creating a GitHub Release in the repository. It also utilizes dotnet tooling for deployment tasks.

The EmberConcentratorType enumeration defines how a concentrator manages source routes based on its available memory:

• EMBER_HIGH_RAM_CONCENTRATOR: Used when the device has sufficient memory to store source routes for the entire network. Remote nodes stop sending route records once the concentrator has successfully received one.
• EMBER_LOW_RAM_CONCENTRATOR: Used when the device has insufficient RAM to store all outbound source routes. In this mode, remote nodes send route records to the concentrator prior to every inbound APS unicast.

The EzspGetBindingRemoteNodeIdRequest class implements the Ember EZSP command getBindingRemoteNodeId. It is used to retrieve the node ID for a binding's destination, provided the ID is already known by the stack.

Behavioral Notes:

• If a message is sent using a binding but the destination's ID is unknown, the stack will attempt to discover the ID by broadcasting a ZDO address request.
• To avoid discovery overhead, you can use setBindingRemoteNodeId if the ID is already known through other means.
• The destination's node ID is cleared when:
  • The binding is changed.
  • The local node reboots.
  • The destination node changes its ID due to an ID conflict (rare).

var request = new EzspGetBindingRemoteNodeIdRequest();
request.SetIndex(0); // Set the index of the binding table entry
int[] payload = request.Serialize();

The EzspGetCertificateResponse class is used to process the response from the Ember EZSP getCertificate command. This command is used to retrieve the certificate installed on the Network Co-Processor (NCP).

When a response is received, the class deserializes the EmberStatus (the result of the CBKE operation) and the EmberCertificateData (the locally installed certificate).

// Example of accessing the response data
// Assuming 'inputBuffer' is the raw byte array received from the hardware
var response = new EzspGetCertificateResponse(inputBuffer);

EmberStatus status = response.GetStatus();
EmberCertificateData localCert = response.GetLocalCert();

Console.WriteLine($"Status: {status}");
Console.WriteLine($"Certificate: {localCert}");

The EzspFindKeyTableEntryRequest class implements the Ember EZSP command findKeyTableEntry. This command searches the Key Table for an entry that matches specific criteria.

Search Criteria:

• Address: The IeeeAddress to search for. Passing an address of all zeros allows searching for the first available empty entry.
• Link Key Flag: A boolean indicating the type of key to search for. Setting this to true searches for an entry containing a Link Key; otherwise, it searches for a Master Key.

var request = new EzspFindKeyTableEntryRequest();
request.SetAddress(someIeeeAddress);
request.SetLinkKey(true); // true for Link Key, false for Master Key

// To retrieve the configured values:
IeeeAddress address = request.GetAddress();
bool isLinkKey = request.GetLinkKey();

The EzspSendTrustCenterLinkKeyResponse class is used to process the response from an Ember EZSP sendTrustCenterLinkKey command. This command sends an APS TransportKey command containing the current trust center link key to a specific node identified by its short and long addresses.

When receiving this response, you should check the EmberStatus to determine if the operation succeeded or failed.

// Example of checking the status of a response
// Assuming 'response' is an instance of EzspSendTrustCenterLinkKeyResponse
EmberStatus status = response.GetStatus();

if (status == EmberStatus.Success) // Note: EmberStatus.Success is an assumed value from the EmberStatus enum
{
    // Handle success
}
else
{
    // Handle failure
}