README.md 3.03 KB
Newer Older
Dave Griffiths's avatar
docs  
Dave Griffiths committed
1 2 3
Symbai/Starwisp
===============

Dave Griffiths's avatar
docs  
Dave Griffiths committed
4 5 6
This is a data syncing application for remote use with a raspberry pi
and android devices. The whole system needs to work without internet or
power, for example working from solar powered devices.
Dave Griffiths's avatar
docs  
Dave Griffiths committed
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37

Development notes
=================

Data model
----------

The sqlite database is using an entity-attribute-value system so data types can
be added dynamically, with only an android application update required.

Each item in the database is an entity, which contains a version number,
a local id (the primary key) which is defined on the local database only
and a unique-id which is common to all databases across the
network. Entities are split into different types, and are associated
with attributes which make up their contents. The attributes of the
entity are stored in key-type-value attributes (ktv). Entities are
comprised of multiple ktv attributes.

When an entity is edited, it's flagged as dirty - along with the
individual attributes which are changed.

The entity dirty flag is used to determine which entities need to be
sent to the server when syncing, and the attribute's dirty flags
indicate which individual items need sending.

The server increments the entity version number on reciept of a changed
values, which is used to determine which entities are needed updating on
other clients.

In this way, data changes are merged and propagated through the system.

Dave Griffiths's avatar
docs  
Dave Griffiths committed
38
Files can be associated with attributes, and are synced (e.g. images)
Dave Griffiths's avatar
docs  
Dave Griffiths committed
39

Dave Griffiths's avatar
docs  
Dave Griffiths committed
40 41
Syncing algorithm
-----------------
Dave Griffiths's avatar
docs  
Dave Griffiths committed
42

Dave Griffiths's avatar
docs  
Dave Griffiths committed
43
Sending data from client to server is all about dirty flags:
Dave Griffiths's avatar
docs  
Dave Griffiths committed
44

Dave Griffiths's avatar
docs  
Dave Griffiths committed
45
| Android (client)              |   Raspberry Pi (server)      |
Dave Griffiths's avatar
docs  
Dave Griffiths committed
46 47 48
|-------------------------------|------------------------------|
| Data edited or created - cause entities and attributes to be flagged as 'dirty' |      |
| For each dirty entity, send all dirty attributes | Return message to confirm reciept |
Dave Griffiths's avatar
docs  
Dave Griffiths committed
49
| Clean dirty flags on returned message | |
Dave Griffiths's avatar
docs  
Dave Griffiths committed
50 51
|                               | Overwrite all dirty attributes, increment version number |

Dave Griffiths's avatar
docs  
Dave Griffiths committed
52 53
Receiving changes from the server to the client is all about version numbers:

Dave Griffiths's avatar
docs  
Dave Griffiths committed
54
| Android (client)              |   Raspberry Pi (server)      |
Dave Griffiths's avatar
docs  
Dave Griffiths committed
55 56 57 58 59 60
|-------------------------------|------------------------------|
| Request all entity version numbers | Send versions...      |
| Check each local entity, request updates | Send complete entity, with all attributes |
| Overwrite/add new entities    |  |


Dave Griffiths's avatar
docs  
Dave Griffiths committed
61 62
Code dependancies
-----------------
Dave Griffiths's avatar
docs  
Dave Griffiths committed
63

Dave Griffiths's avatar
docs  
Dave Griffiths committed
64
Common code is stored in /eavdb and is platform independant, running on android (tinyscheme) and raspberry pi (racket).
Dave Griffiths's avatar
docs  
Dave Griffiths committed
65

Dave Griffiths's avatar
docs  
Dave Griffiths committed
66 67 68 69
         ktv ---> ktv-list      sql/racket-fix
          \         |              /
           \        V             /
            --> entity-values  <--
Dave Griffiths's avatar
docs  
Dave Griffiths committed
70 71 72 73 74 75 76 77 78 79 80 81
                 |        |
                 V        V
        entity-insert    entity-get
                 |        |
                 V        V
                entity-update
                 |   |    |
                 V   |    V
        entity-sync  |   entity-filter
                 |   |    |
                 V   V    V
                    eavdb