design.rst 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566
  1. .. Note
  2. Copyright 2017 Digital
  3. This file is part of BeeWatch.
  4. BeeWatch is free software: you can redistribute it and/or modify
  5. it under the terms of the GNU General Public License as published by
  6. the Free Software Foundation, either version 3 of the License, or
  7. (at your option) any later version.
  8. BeeWatch is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. GNU General Public License for more details.
  12. You should have received a copy of the GNU General Public License
  13. along with BeeWatch. If not, see <http://www.gnu.org/licenses/>.
  14. Program Design
  15. ==============
  16. This page explains the structure of BeeWatch.
  17. .. Note::
  18. This is how i want it to be, not how it is right now. In the current state the core and the server are not separated, the core opens a public server.
  19. Core
  20. -----
  21. The Core handles gpio stuff and analyses data. The data can be accessed through a file socket opened by the Core.
  22. Server
  23. ------
  24. The Server connects to the file socket of the core and serves has extensions for different types of (public) apis. authentication will be implemented using ssl, username/password or both.
  25. Client
  26. ------
  27. The Client is the front end of BeeWatch. Right now it is a program but I plan a web interface client.
  28. ..