Shift-4-Haystack
The full documentation is here
About Haystack, and who is it for
Haystack project is an open source initiative to standardize semantic data models for Internet Of Things. It enables interoperability between any IoT data producer and consumer, mainly in the Smart Building area.
Haystack core data model is the Grid, it can be serialized in many formats, mainly Zinc, Trio Json and Csv
About this project
This project implements client side haystack code. Useful to parse or dump Haystack files (Zinc, Json, Trio and Csv).
On the server side, it also implements Haystack HTTP API, useful to serve Haystack data you host.
- We implemented different serving options See API Server
- Each offering two API endpoints:
- Classical Haystack HTTP API
- GraphQL API
- Each offering two API endpoints:
- We introduced and implemented the Provider concept, which handles various options in terms on haystack data
location:
- Local or remote file system (including AWS S3)
- Local or remote relational database
- Local or remote Mongo database
- Can be extends with optional AWS Time Stream use for Time Series
- Other custom data location can be handled by extending
shaystack.providers.HaystackInterface
Table of contents
- Quick link
- About Haystack, and who is it for
- About this project
- History
- Client side: Haystack client python module
- Features
- Server Side: Haystack API Server
- Using Haystack API with UI
- Using GraphQL API
- Specification extension
- Haystack filter
- Add Haystack API to an existing project
- Using AWS
- Docker
- Using with Excel or PowerBI
- Optional part
- Data types
- Contributing
- Resources
- License
- TODO
and the documentation of API is here