Skip to content
Ron Gatenio edited this page Jul 3, 2017 · 46 revisions

Welcome to the Smartcity-Smarthouse wiki

Welcome to the Smarthouse Wiki!

This wiki contains documentation and useful guides on Smarthouse usage as a Smarthouse-owner, and Smarthouse development as a developer.

Below is a short summery of our wiki categories, in an easily navigable structure:

Quick Start

Smarthouse Usage for Owners

  • Smarthouse Owner Manual
    Smarthouse owner Looking for guides on house operation? look no further.
    Here you can find a detailed manual on how to operate your Smarthouse.

Development Manuals

Joining the team? Learn everything you need here.

  • 3rd Party Application Developers Manual
    Developing an application for the Smarthouse? read here for the do's and don'ts.
    Read here to learn how to install and use the application API, and how to create a simulation to allow you to test your application without psychical sensors.

  • 3rd Party Sensor Developers Manual
    Designing a real sensor that will interact with a smarthouse? read here about the minimal requirements.
    Read here to learn on the manner of communication expected between a sensor and the system, and the protocol of messages defined between the sides.

  • System Developers Manual
    Care to expend on our operating system? read here to see where you should start
    Read here to learn how to expand different parts of the system, and which new features you can implement in order to extend the functionality of the Smarthouse.

Overview

  • System Overview
    This category contains information about the components of our system, how they communicate and connect and what they offer.
    Read here if you're interested in how (in the lower level) information is transferred in the system from sensors to the requesting applications.

Continuous Development

This section contains entries relating to fact that the project is not "finished" and is currently being developed.

  • Known Bugs
    This page contains a summery of all the known bugs in the system. This includes (but not limited to) the issues marked as "bug" in our github repository.

  • Development Process
    If you're interested in our development process, please look in to this category. It contains protocols of our team and stand-up meetings, milestones documentation and more.

Miscellaneous

Clone this wiki locally