Skip to content
This repository has been archived by the owner on Dec 1, 2017. It is now read-only.

Latest commit

 

History

History
76 lines (50 loc) · 4.46 KB

README.md

File metadata and controls

76 lines (50 loc) · 4.46 KB

DEVELOPMENT HALTED

isaac-core wercker status Coverage Status

logo

About

Isaac(Intelligent System And Automation Control) is a platform for automating all sorts of machines, primarily focused on home appliances. It is currently composed of several different modules including isaac-core, isaac-dashboard, isaac-server, isaac-web & isaac-integrations. isaac-core is written primarily in modern c++ and is capable enough to run on any development board supporting linux. It is currently under heavy development and is focusing on first alpha release for now.

Key Features

  • Multithreaded design for responsive operations
  • Event loop based asynchronous IO
  • Efficient websockets implementation instead of weak ajax based polling
  • Uses json format for communication of messages and operations, making integrations easier
  • Powerful logging integration, every bad operation/crash gets tracked
  • Async task-based parallelism
  • Well defined gpio implementation providing abstractions for appliance integrations
  • More coming soon...

Development

Isaac-core(current repository) is written in c++14 and is built using meson build system. It has some notable dependencies including -

  • uWebsockets
  • Json
  • spdlog

which might have their own sub-dependencies. However the build configuration has been fully automatized and it builds the project fetching required dependencies on its own. Emulation of development board is also in progress and some parts like access to gpio pins have been emulated so far. The project is tested continously against multiple compilers and code coverage is calculated for every commit added to the project.

How to build

The recommended way is to install docker and pull the docker image - agauniyal/isaac-app. It contains everything you need to work on the development of isaac app stack and will be updated regularly. Here's an workflow -

asciicast

The other way is to setup your own machine with all the dependencies needed to build the project. The list includes but isn't limited to libuv1, openssl, zlib, git, meson, pkgconfig and ninja build system. You can take a look at wercker.yml file in project's root which contains all the necessary step to build this project. Feel free to open any number of issues here. PRs are also welcomed.

Progress

Progress can be tracked by milestones and project cards which are regularly updated. The links to the following are given below -

Contact

License

MIT License

Copyright (c) 2016 Abhinav Gauniyal

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.