Question-and-Answer Resource for the Building Energy Modeling Community
Get started with the Help page
Ask Your Question

Python EMS actuators

asked 2021-05-18 23:14:18 -0500

mechyai's avatar

updated 2021-05-19 08:30:49 -0500


I am familiarizing myself and playing around with the Python EMS API and using E+ as a library. I am comfortable with the workflow and API itself - I am using this for RL algorithms. I have successfully been able to play around with calling various sensor values using DataExchange and .rdd file with Output:Variable's.

However, I have been having trouble understanding how to implement actuators. Getting an actuator's handle is a bit more complicated. My .idf does not contain any EMS actuators so I am trying to define an arbitrary HVAC actuator object(s) myself, however, I do not understand how to do this well enough - I do not know how to find/implement the various required actuator fields (I have not found documentation explaining the 'syntax' of IDFs, it's still a bit ambiguous how the naming convention and fields work). Likewise, I am confused by the arguments required for getting an actuator's handle for the API: component type (category), control type (name), and actuator key (instance).

Any help would be appreciated.

edit retag flag offensive close merge delete

1 Answer

Sort by ยป oldest newest most voted

answered 2021-05-19 01:56:46 -0500

S.Wang's avatar

Hi, the actuators used by Python API are actually the same as those for EMS. So If you want to know the component type (category), control type (name), and actuator key (instance), please: 1. use an object called Output: Energy Management System in your IDF; 2. run the IDF in EP Launch; 3. click the EDD button in your EP Launch; 4. find the actuator you want in the pop-up text file; 5. in the text file: component unique name = actuator key, component type = component type, control type = control type.

I tried to use actuators in Python API without defining them in IDF EMS in advance, and it worked.

Hope this can help you.

edit flag offensive delete link more


If you search Unmet Hours for "energyplus actuator" you will find lots of posts. This one is helpful.

Aaron Boranian's avatar Aaron Boranian  ( 2021-05-19 08:36:37 -0500 )edit

Thank you both!

mechyai's avatar mechyai  ( 2021-06-03 13:50:00 -0500 )edit

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Training Workshops


Question Tools

1 follower


Asked: 2021-05-18 23:14:18 -0500

Seen: 632 times

Last updated: Feb 04 '22