Agent Specifications

Documents included below are intended to provide a specification to classes of agents which include a base class in the VOLTTRON repository and have a well defined set of functions and services.

• Aggregate Historian
  • Description
  • Software Interfaces
  • User Interfaces
  • Functional Capabilities
  • Data Structure
  • Use Cases
    • Collect monthly average of multiple topic using data from MongoDBHistorian
    • Collect weekly average(sunday to saturday) of single topic using data from MongoDBHistorian
    • Collect hourly average for multiple topics based on topic_name pattern
    • Collect 7 day average of two topics and time synchronize them for easy comparison
    • Qurey list of aggregate data collected
    • Qurey list of supported aggregation types
  • Constraints and Limitations
• Tagging Service
  • Description
  • Taxonomy
  • Dependency
  • Features
  • API
    • 1. Get the list of tag categories available
    • 2. Get the list of tags for a specific category
    • 3. Get the list of tags for a topic_name or topic_name_prefix
    • 4. Find topic names by tags
    • 5. Query data based on tags
    • 6. Add tags to specific topic name or topic name prefix
    • 7. Add tags to multiple topics
  • Use case examples
    • 1. Loading news tags for an existing VOLTTRON instance
      • Step 1:
      • Step 2: Create tags using template above
      • Step 3: Create tags specific to a point or device
    • 2. Querying based on a topic’s tag and it parent’s tags
  • Possible future improvements
• Weather Service
  • Description
  • Features
  • API
    • 1. Get available features
    • 2. Get current weather data
    • 3. Get hourly forecast data
    • 4. Get historical weather data
    • 5. Periodic polling of current weather data
  • Configuration
  • Caching
  • Assumptions