blob: da48cf15af69258b0119d6ee0980b8845db24edd (
plain)
1
2
3
4
5
6
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
38
39
40
41
42
43
44
45
46
47
|
# puzzle box client
This folder contains the source code for the puzzle box client (pbc). This is a
desktop application that communicates with the main controller over TCP to
send/receive I<sup>2</sup>C messages. This application is not only used by a
game operator to control and monitor the state of a puzzle box, but is also a
useful debugging tool when developing puzzle modules, as it allows you to send
arbitrary data over the puzzle bus.
## WIP TODO
- cleanup
- separate ../shared/pb/moddrv.c into a puzzle module specific and 'common' bit
- use the common bit in i2c.cpp instead
- cast to structs in ../shared/pb/moddrv.c
- functionality
- print pretty tree of connected puzzle modules
- add enum to string functions in CLIENT ONLY
## Features
- List detected puzzle modules
- Reset puzzle modules (individually or all to reset the box)
- Skip puzzle modules (individually or all)
- Request puzzle box state
Debug only:
- Send arbitrary messages
## Building
PBC is a standard CMake project, but a [makefile](./makefile) is provided for
convenience (still requires CMake and Ninja are installed).
## Send data
```
ADDRESS DATA
v~~~ v~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
send 0x39 68:65:6c:6c:6f 44 0x20 'world' 33
^~~~~~~~~~~~~~ ^~ ^~~~ ^~~~~~~ ^~
HEXSTR NUMBER NUMBER STRING NUMBER
(binary) (dec) (hex) (literal) (dec)
```
The data is concatenated, and may contain mixed types of literals
|