Skip to content

analogdevicesinc/energy-adc-service

Repository files navigation

ADI Logo

Energy ADC Service

Energy ADC Service provides a set of APIs to communicate with ADI metrology ADCs and collect waveform samples. This release supports ADE9113, ADE9112, ADE9103, ADEMA124, and ADEMA127. These ADCs use a command and response protocol over the SPI interface. Refer to the datasheets of the respective ADCs and the energy-ade-registers repository for details on the command and response protocols.

This repository contains source code for the service and example code demonstrating how to use the APIs. The examples use the following submodules for demonstrations:

To clone the repository and its submodules, use the following command:

git clone --recursive https://github.com/analogdevicesinc/energy-adc-service.git

The sample_read_example demonstrates how to call various APIs and interface functions of the ADC Service. The repository also contains sources for ACE evaluation firmware.

Supported Features

  • Configure and read samples from supported ADI ADCs
  • Daisy chain multiple ADCs
  • Read and write ADC registers without interrupting sample collection
  • Synchronize multiple ADCs in a daisy chain
  • Configure DSP registers
  • Add sample delays to individual channels
  • Example code for tamper detection mode

Directory Structure

energy-adc-service/
├── include/             # ADC service API header files and other include files
├── source/              # ADC service source files
├── interface/           # Example files showing how to call various service APIs
├── examples/            # ADC service example firmware files
├── eval_firmware/       # ADC service evaluation firmware files
├── ade_registers/       # Submodule for IC register definitions
├── board_support/       # Submodule for board drivers and support files
├── docs/                # Release notes and API documentation
├── firmware_services/   # Submodule for CLI and other firmware services

Refer to integration_instructions.md for instructions on integrating the ADC Service into a new project.

API Documentation

The API documentation can be generated using Doxygen. Install the following tools and add them to your system path:

Use the following command from the documentation folder to generate the documentation:

doxygen adc_service_doxy_config

The documentation will be generated in the output directory specified in the Doxygen configuration.

Contributing

Contributions are welcome! See CONTRIBUTING.md for details.

License

This project is licensed under the Apache 2.0 License.

Contact

For questions or support, please open an issue on the GitHub repository.

About

No description, website, or topics provided.

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published