Welcome to pyhaystack’s documentation!¶

pyhaystack ¶

What is this ?¶

Pyhaystack is a module that allow python programs to connect to a haystack server using semantic data model for buildings (project-haystack).

Browse a campus, building, floor... find VAV boxes, AHU units, etc. Then extract history data from them and get the results ready for analysis using pandas or your own database implementation.

Which clients are implemented ?¶

Actually, connection can be established with :

NiagaraAX by Tridium
Widesky by VRT
Skyspark by SkyFoundry

Connection to Niagara AX requires the nHaystack module by J2 Innovations

How do I install pyhaystack ?¶

pip install pyhaystack

Or you can also git clone the develop branch and use

python setup.py install

What is project-haystack ?¶

As stated in the web site

“Project Haystack is an open source initiative to streamline working with data from the Internet of Things. We standardize semantic data models and web services with the goal of making it easier to unlock value from the vast quantity of data being generated by the smart devices that permeate our homes, buildings, factories, and cities. Applications include automation, control, energy, HVAC, lighting, and other environmental systems.”

—Project-Haystack

New implementation¶

We’ve been reworking everything from the early version. Now, pyhaystack is more robust and will be ready for asynchronous development.

This new implementation has been mostly supported by VRT and Servisys. We are hoping that more people will join us in our effort to build a well working open-source software that will open the door of building data analysis to Python users.

Dependency¶

Pyhaystack highly depend on hszinc which is a special parser for zinc encoded data. Zinc was created for project-haystack as a CSV replacement.

For analysis, we also suggest using Pint to deal with units. It will bring a lot of possibilities to pyhaystack (ex. unit conversion)

Modules documentation¶

pyhaystack package¶

Subpackages¶

Submodules¶

pyhaystack.exception module¶

This module allow a connection to a haystack server Feautures provided allow user to fetch data from the server and eventually, to post to it.

See http://www.project-haystack.org for more details

Project Haystack is an open source initiative to streamline working with data from the Internet of Things. We standardize semantic data models and web services with the goal of making it easier to unlock value from the vast quantity of data being generated by the smart devices that permeate our homes, buildings, factories, and cities. Applications include automation, control, energy, HVAC, lighting, and other environmental systems.

exception pyhaystack.exception.AuthenticationProblem¶: Bases: exceptions.Exception

exception pyhaystack.exception.HaystackError(message, traceback=None, *args, **kwargs)¶

Bases: exceptions.Exception

Exception thrown when an error grid is returned by the Haystack server. See http://project-haystack.org/doc/Rest#errorGrid

exception pyhaystack.exception.NoCookieReceived¶: Bases: exceptions.Exception

exception pyhaystack.exception.NoResponseFromServer¶: Bases: exceptions.Exception

exception pyhaystack.exception.ProblemReadingCookie¶: Bases: exceptions.Exception

exception pyhaystack.exception.ProblemSendingRequestToServer¶: Bases: exceptions.Exception

exception pyhaystack.exception.UnknownHistoryType¶: Bases: exceptions.Exception

pyhaystack.info module¶

File : pyhaystackTest.py (2.x) This module allow a connection to a haystack server Feautures provided allow user to fetch data from the server and eventually, to post to it.