VOLTTRON / volttron

VOLTTRON Distributed Control System Platform
https://volttron.readthedocs.io/
Other
460 stars 218 forks source link

VC Status Support #247

Closed craig8 closed 8 years ago

craig8 commented 8 years ago

https://guides.github.com/features/mastering-markdown/In order for the ui to support status, the volttron central api responses should include a status field for all api responses. A status response will be contained in the normal json rpc protocol format.

# There will be an optional status object that can be appended onto the json rpc
# response as follows.
{
    "result": {
        "data_result_of_call": [ "data", "data", "data2"],
        "status": {
             "code": "success or errror",
             "msg": "This is the message to be displayed as a result."
        }
    }
}

Things that must contain statuses

As an integration point. The platform queries the platform historian for a specific topic. While this does fall into the third bullet above, this is an instance where the platform historian has knowledge of whether a topic exists or not. The platform historian agent can raise an exception that gets propogated up to the platform and either th platform itself or the vc can translate that into the proper response.

craig8 commented 8 years ago

All agents now have a status() function that the agent can modify internally as of b7639b68f557b2cbfcbfd73565c81051fb7fe929