Telemetrix Under The Hood Part 5

Summarizing - Adding New Features

Let's quickly summarize the steps needed to add new features to Telemetrix.

• Have a clear understanding of Telemetrix messaging.
• Select an Appropriate support library for your device.

Adding A New Command

• Select a new command ID for the device.

• Server Changes

  • Add this ID to the server code.
  • Add a #define for the new feature.
  • Select a name for the new command handler and add this to the forward references.
  • Add the new command handler name to the command descriptor table.
  • Write the implementation code for the new device.
  • Update the firmware version number.

• Client API Changes

  • Add the new command ID to the client's private constants file.
  • Update the client version number.
  • If the new feature requires instance-level storage, allocate it in the init method.
  • Write and add the new implementation code as a method to the API class.

Adding A New Report

• Select a new report ID.

• Server Changes

  • Add this ID to the server code.
  • If the new feature requires persistent storage, add it to the server file.
  • To continuously monitor the device, write a polling function using the device library you selected above.
  • Add the polling function to the loop function.
  • Optionally, you can write a one-shot function to poll the device.

• Client API Changes

  • Add the ID to the client API private constants file
  • Add any storage you might need to handle the report
  • Write a report handler method and add it to the API class.
  • Add a new entry into the report dispatch dictionary.

Comments