README.design

Sun, 12 May 2019 17:08:58 +0200

author
Michiel Broek <mbroek@mbse.eu>
date
Sun, 12 May 2019 17:08:58 +0200
changeset 361
9f07e2f47ec8
parent 359
98354ef399cd
child 364
487274c2e9dc
permissions
-rw-r--r--

Moved some stuff to the real documentation.

0
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
1 Centrale daemon 'bmsd' regelt de dagelijkse berichten tussen MQTT en de
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
2 database. Om deze berichten betrouwbaar af te handelen is MQTT er tussen
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
3 gezet.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
4 Alle sensoren en controllers communiceren uitsluitend via MQTT.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
5
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
6 Sensoren en controllers:
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
7
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
8 1. Vergisting controllers.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
9 2. Temperatuur loggen.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
10 3. Hergisting drukmeters. (druk + temp).
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
11 4. Brouw controllers.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
12 5. Ispindel.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
13
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
14
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
15 Stappen:
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
16
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
17 1. Importeren oude vergisting en brouw logs. DONE.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
18 2. Thermferm moet DLOG berichten gaan sturen, per wijziging en per 5 minuten. DONE.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
19 3. bmsd moet deze DLOG berichten verwerken. Versie 0.0.2. Bier producten in database. DONE.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
20 4. Versie 0.0.2 handmatig installeren op productie. DONE.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
21 5. Thermferm uitbreiden met vergisting stage. DONE.
104
0c6ad9e0f143 Updated ideas
Michiel Broek <mbroek@mbse.eu>
parents: 63
diff changeset
22 6. Brouw controller uitbreiden met MQTT. Niet, ESP32 wordt onstabiel.
0c6ad9e0f143 Updated ideas
Michiel Broek <mbroek@mbse.eu>
parents: 63
diff changeset
23 7. bmsd uitbreiden met brouw controller berichten. Niet, zie hierboven.
0c6ad9e0f143 Updated ideas
Michiel Broek <mbroek@mbse.eu>
parents: 63
diff changeset
24 8. bmsd productie platform upgraden, versie 0.0.3 DONE.
268
eb35aa378579 Updated design document.
Michiel Broek <mbroek@mbse.eu>
parents: 248
diff changeset
25 9. bmsd recepten editor implementeren. DONE.
eb35aa378579 Updated design document.
Michiel Broek <mbroek@mbse.eu>
parents: 248
diff changeset
26 10. bmsd uitbreiden met productie (brews) stappen, met hierin recepten. DONE.
325
9a8c650972ca Update some documentation. Thermometer gauges animate easing
Michiel Broek <mbroek@mbse.eu>
parents: 314
diff changeset
27 11. bmsd koppelen logs aan productie. DONE.
21
acb2d8098f19 Added inventory miscs and water sources.
Michiel Broek <mbroek@mbse.eu>
parents: 20
diff changeset
28
18
395833e20f88 Better error messages in syslog
Michiel Broek <mbroek@mbse.eu>
parents: 0
diff changeset
29
0
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
30
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
31
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
32 MQTT structuur volgens Sparkplug model.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
33
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
34 mbv1.0/fermenters/[NBIRTH,DBIRTH]/<hostname>/
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
35 mbv1.0/fermenters/DDATA/<hostname>/<unitalias>/
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
36
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
37 ---------------------------------------------------------------------------
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
38
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
39 namespace/group_id/message_type/edge_node_id/{device_id}
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
40
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
41 namespace is de root, "mbv1.0"
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
42
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
43 group_id oa: fermenters, brewcontrol, env_sensor
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
44
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
45 message_type: NBIRTH - Birth certificate for MQTT EoN nodes.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
46 NDEATH - Death certificate for MQTT EoN nodes.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
47 NCMD - Node command message.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
48 DBIRTH - Birth certificate for devices.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
49 DDEATH - Death certificate for devices.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
50 NDATA - Node data message.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
51 DDATA - Device data message.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
52 DLOG - Device data logging.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
53 DCMD - Device command message.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
54 STATE - Critical application state message.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
55
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
56 NCMD: reboot (application restart)
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
57 rebirth
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
58
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
59 DCMD: fermenter state change + temperature settings.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
60 fermenter profile install.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
61 fermenter load product.
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
62 fermenter set stage
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
63
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
64
109
3c334f3ca7f9 Noted some ideas and added some in the menu.
Michiel Broek <mbroek@mbse.eu>
parents: 108
diff changeset
65 Product: code, uuid en naam.
3c334f3ca7f9 Noted some ideas and added some in the menu.
Michiel Broek <mbroek@mbse.eu>
parents: 108
diff changeset
66 Stage: Plan Wait Brew Primary Secondary Tertiary Package Carbonation Mature Taste Ready Closed
3c334f3ca7f9 Noted some ideas and added some in the menu.
Michiel Broek <mbroek@mbse.eu>
parents: 108
diff changeset
67 | | | | | |
3c334f3ca7f9 Noted some ideas and added some in the menu.
Michiel Broek <mbroek@mbse.eu>
parents: 108
diff changeset
68 | | | | | +------------- Log/rapport
3c334f3ca7f9 Noted some ideas and added some in the menu.
Michiel Broek <mbroek@mbse.eu>
parents: 108
diff changeset
69 | | | | +------------------------ rapport/etiketten
3c334f3ca7f9 Noted some ideas and added some in the menu.
Michiel Broek <mbroek@mbse.eu>
parents: 108
diff changeset
70 | +-------+---------+--------------------------------- Log/rapport
3c334f3ca7f9 Noted some ideas and added some in the menu.
Michiel Broek <mbroek@mbse.eu>
parents: 108
diff changeset
71 +--------------------------------------------------------- Log/rapport
0
033898178630 Versio 0.0.2 initial check in
Michiel Broek <mbroek@mbse.eu>
parents:
diff changeset
72
174
12aacf0da982 Updated the README
Michiel Broek <mbroek@mbse.eu>
parents: 114
diff changeset
73 Main table: products.
355
64d6f3c857d7 Version 0.1.3 development.
Michiel Broek <mbroek@mbse.eu>
parents: 325
diff changeset
74 In progress: overview. DONE.
64d6f3c857d7 Version 0.1.3 development.
Michiel Broek <mbroek@mbse.eu>
parents: 325
diff changeset
75 In Progress: view charts. DONE.
174
12aacf0da982 Updated the README
Michiel Broek <mbroek@mbse.eu>
parents: 114
diff changeset
76 In Progress: view logs.
355
64d6f3c857d7 Version 0.1.3 development.
Michiel Broek <mbroek@mbse.eu>
parents: 325
diff changeset
77 In Progress: update state. DONE.
174
12aacf0da982 Updated the README
Michiel Broek <mbroek@mbse.eu>
parents: 114
diff changeset
78 In Progress: Tabbed screens. DONE.
12aacf0da982 Updated the README
Michiel Broek <mbroek@mbse.eu>
parents: 114
diff changeset
79 Start new: some sort of wizzard like a new recipe. DONE.
355
64d6f3c857d7 Version 0.1.3 development.
Michiel Broek <mbroek@mbse.eu>
parents: 325
diff changeset
80 Archive: select via name/code/date. DONE.
109
3c334f3ca7f9 Noted some ideas and added some in the menu.
Michiel Broek <mbroek@mbse.eu>
parents: 108
diff changeset
81 Calendar: shows upcoming events.
355
64d6f3c857d7 Version 0.1.3 development.
Michiel Broek <mbroek@mbse.eu>
parents: 325
diff changeset
82 Recipes can be copied to 'recipes' or 'brews', imported from 'recipes'/'products' or created manual. DONE.
64d6f3c857d7 Version 0.1.3 development.
Michiel Broek <mbroek@mbse.eu>
parents: 325
diff changeset
83 Products recipes Beerxml import. DONE.
180
a5aa3502310c Updated README. Getfermenter and getnode scripts return 0 and 1 instead of false and true for boolean values. Global variable my_uuid added. Moved the javascript out of mon_fermenter.php. Added log chart view button in the fermenter monitor.
Michiel Broek <mbroek@mbse.eu>
parents: 174
diff changeset
84 Recipes Beerxml import.
106
c64d979613ab Prepare for production brews databases
Michiel Broek <mbroek@mbse.eu>
parents: 104
diff changeset
85
194
d202777ebae5 Added design notes for the csv log format from fermenters. In bmsd configuration added the web_root entry. Switched fermenter DLOG messages to store the log in flat csv files instead of the database. This is much faster and the graphs look better.
Michiel Broek <mbroek@mbse.eu>
parents: 180
diff changeset
86
d202777ebae5 Added design notes for the csv log format from fermenters. In bmsd configuration added the web_root entry. Switched fermenter DLOG messages to store the log in flat csv files instead of the database. This is much faster and the graphs look better.
Michiel Broek <mbroek@mbse.eu>
parents: 180
diff changeset
87 -----------------------------------------------------------------------------
d202777ebae5 Added design notes for the csv log format from fermenters. In bmsd configuration added the web_root entry. Switched fermenter DLOG messages to store the log in flat csv files instead of the database. This is much faster and the graphs look better.
Michiel Broek <mbroek@mbse.eu>
parents: 180
diff changeset
88
290
12aa92828e24 Added view archives by name
Michiel Broek <mbroek@mbse.eu>
parents: 268
diff changeset
89 TODO:
12aa92828e24 Added view archives by name
Michiel Broek <mbroek@mbse.eu>
parents: 268
diff changeset
90
12aa92828e24 Added view archives by name
Michiel Broek <mbroek@mbse.eu>
parents: 268
diff changeset
91 Export ingredienten naar xml.
12aa92828e24 Added view archives by name
Michiel Broek <mbroek@mbse.eu>
parents: 268
diff changeset
92
313
9f45d09c2071 Added alcohol tolerance field in the yeasts database.
Michiel Broek <mbroek@mbse.eu>
parents: 312
diff changeset
93 Extra:
9f45d09c2071 Added alcohol tolerance field in the yeasts database.
Michiel Broek <mbroek@mbse.eu>
parents: 312
diff changeset
94
314
f943efa07d9f Added yeast duplicate button
Michiel Broek <mbroek@mbse.eu>
parents: 313
diff changeset
95 Gisten diastaticus bit toevoegen.
313
9f45d09c2071 Added alcohol tolerance field in the yeasts database.
Michiel Broek <mbroek@mbse.eu>
parents: 312
diff changeset
96 Gist typen: kveik en brett? Apart of niet.
9f45d09c2071 Added alcohol tolerance field in the yeasts database.
Michiel Broek <mbroek@mbse.eu>
parents: 312
diff changeset
97

mercurial