├── LICENSE
├── README.md
├── bookoo_mini_scale
└── protocols.md
└── espresso_monitor
└── protocols.md
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2024 BooKoo
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # OpenSource
2 | BooKoo OpenSource Project.Bluetooth protocols including Espresso Monitor, BooKoo Scale, etc.
3 |
--------------------------------------------------------------------------------
/bookoo_mini_scale/protocols.md:
--------------------------------------------------------------------------------
1 | # MINI SCALE Transmission protocol
2 | - Contact Us: develop@bookoocoffee.com
3 | - Last Update: 2April 8, 2024
4 |
5 | >All BLE UUIDs adopted by the BOOKOO MINI SCALE use a simplified representation of the 16-bit UUID, and its corresponding 128-bit UUID is the unified structure agreed upon by the Bluetooth Association, i.e. 0000 xxxx -0000-1000-8000-00805F9B34FB
6 |
7 | ## 1. Bluetooth Protocol Basic Info And Check Sum
8 | > All data are transferred in hexadecimal
9 |
10 | ### Basic Info
11 |
12 | Service UUID: 0x0FFE
13 |
14 | Characteristic UUID:
15 |
16 | - Command Characteristic UUID: 0xFF12
17 | - Weight Data Characteristic UUID: 0xFF11
18 |
19 | ### Check Sum Method
20 |
21 | Method: XOR Calculation
22 | ```
23 | CheckSum = Header1 ^ Header2 ^ Data0 ^ Data1 ^ ... ^ DataN
24 |
25 | if CheckSum == DataSUM
26 | pass
27 | ```
28 |
29 | # 2. Transmission Data
30 |
31 | ### Command Data
32 |
33 | | BYTE1 | BYTE2 | BYTE3 | BYTE4 | BYTE5 | BYTE6 | DESCRIPTION |
34 | | ----------- | ----------- |----------- |----------- |----------- |----------- |----------- |
35 | | PRODUCT NUMBER | TYPE | DATA1 | DATA2 | DATA3 | DATASUM |DESCRIPTION |
36 | | 03 | 0A | 01 | 00 | 00 | 08 | Send the tare command |
37 | | 03 | 0A | 02 | 00~05 (Beep level) | 00 | checkSum | Adjust the beep size, 0 means no beeper sound on |
38 | | 03 | 0A | 03 | 01~1e (Auto-off duration) | 00 | checkSum | Adjust the automatic shutdown duration from 1-30 minutes |
39 | | 03 | 0A | 04 | 00 | 00 | 0a | Send the start timer command |
40 | | 03 | 0A | 05 | 00 | 00 | 0d | Send the stop timer command |
41 | | 03 | 0A | 06 | 00 | 00 | 0c | Send the reset timer command |
42 | | 03 | 0A | 07 | 00 | 00 | 00 | Send the tare and start time command (recommend) |
43 | | 03 | 0A | 08 | 00/01 | 00 | checkSum | Whether or not flow smoothing is turned on, 00 means it is not turned on, 01 means it is turned on |
44 |
45 | ### Receiving Weight
46 |
47 | >Note: The current weight unit only supports grams
48 |
49 | | BYTE1 | BYTE2 | BYTE3 | BYTE4 | BYTE5 | BYTE6 | BYTE7 |BYTE8 |BYTE9 |BYTE10 |BYTE11 |BYTE12 |BYTE13 |BYTE14 |BYTE15 |BYTE16 |BYTE17 |BYTE18 |BYTE19 |BYTE20 |DESCRIPTION |
50 | | ----------- | ----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |
51 | | PRODUCT NUMBER | TYPE | DATA1 | DATA2 | DATA3 | DATA4 | DATA5 | DATA6 | DATA7 | DATA8 | DATA9 | DATA10 | DATA11 | DATA12 | DATA13 | DATA14 | DATA15 | DATA16 | DATA17 | DATASUM |DESCRIPTION |
52 | | 03 | 0B |
MillSeconds
High byte of a unsigned Short integer |MillSeconds
Mid byte of a unsigned Short integer |MillSeconds
Low byte of a unsigned Short integer | unit of weight |Weight symbol data points (+/-)|
Grams weight * 100
High byte of a unsigned Short integer |
Grams weight * 100
Mid byte of a unsigned Short integer |
Grams weight * 100
Low byte of a unsigned Short integer |Flow rate symbol data points (+/-)|Flow rate*100
High byte of a unsigned Short integer|Flow rate*100
Low byte of a unsigned Short integer|Percentage of remaining power | standby time (min)
High byte of a unsigned Short integer |standby time (min)
Low byte of a unsigned Short integer| Buzzer gear | Flow Rate Smoothing Switch |00 |00 | Get time, weight, flow rate and power percentage data on the scale |
53 |
54 | ### Other Data
55 |
56 | It is currently not open, so contact us if you need it.
57 |
58 | Email: develop@bookoocoffee.com
59 |
--------------------------------------------------------------------------------
/espresso_monitor/protocols.md:
--------------------------------------------------------------------------------
1 | # Espresso Monitor Transmission protocol
2 | - Contact Us: develop@bookoocoffee.com
3 | - Last Update: 2April 8, 2024
4 | > All BLE UUIDs adopted by the Espresso Monitor use a simplified representation of the 16-bit UUID, and its corresponding 128-bit UUID is the unified structure agreed upon by the Bluetooth Association, i.e. 0000 xxxx -0000-1000-8000-00805F9B34FB
5 |
6 | ## 1. Bluetooth Protocol Basic Info And Check Sum
7 | > All data are transferred in hexadecimal
8 |
9 | ### Basic Info
10 |
11 | Service UUID: 0x0FFF
12 |
13 | Characteristic UUID:
14 |
15 | - Command Characteristic UUID: 0xFF01
16 | - Extraction Data Characteristic UUID: 0xFF02
17 |
18 | ### Check Sum Method
19 |
20 | Method: XOR Calculation
21 | ```
22 | CheckSum = Header1 ^ Header2 ^ Data0 ^ Data1 ^ ... ^ DataN
23 |
24 | if CheckSum == DataSUM
25 | pass
26 | ```
27 |
28 | ## 2. Transmission Data
29 |
30 | ### Command Data
31 |
32 | | BYTE1 | BYTE2 | BYTE3 | BYTE4 | BYTE5 | BYTE6 | BYTE7 | DESCRIPTION |
33 | | ----------- | ----------- |----------- |----------- |----------- |----------- |----------- |----------- |
34 | | PRODUCT NUMBER | TYPE | DATA1 | DATA2 | DATA3 | DATA4 | DATASUM |DESCRIPTION |
35 | | 02 | 0C | 00 | 00 | 00 | 00 | 0e | Send a stop extraction command |
36 | | 02 | 0C | 01 | 00 | 00 | 00 | 0f | Send a start extraction command |
37 |
38 | ### Extraction data
39 | >Pressure data is sent by default as a two-byte unsigned short integer in bar, pressure * 100.
40 |
41 | | BYTE1 | BYTE2 | BYTE3 | BYTE4 | BYTE5 | BYTE6 | BYTE7 | BYTE8 |BYTE9 |BYTE10 |DESCRIPTION |
42 | | ----------- | ----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |----------- |
43 | | 02 | 1B | 00 | 00 |
Pressure*100(bar)
High byte of a unsigned Short integer |
Pressure*100(bar)
Low byte of a unsigned Short integer | Percentage of power remaining (%) |00 |00 |00 | Receives pressure data |
44 |
45 | ### Other Data
46 |
47 | It is currently not open, so contact us if you need it.
48 |
49 | Email: develop@bookoocoffee.com
50 |
--------------------------------------------------------------------------------