forked from srynot4sale/freeems-tuner
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README
76 lines (50 loc) · 1.86 KB
/
README
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
See INSTALL for installation instructions
FreeEMS-Tuner was written by Aaron Barnes <aaron.barnes@hbcosmo.com>
Once installed using the instructions in INSTALL, to run the program
simple navigate to the freeems-tuner directory and type into the prompt:
python main.py
And you are away!
Basic layout of program directory:
freeems-tuner_version/
comms/
Contains comms plugins for connecting to hardware
Released plugins include:
Serial.py
Basic serial communications
Test.py
Debugging connection
data/
Contains per-user settings and log files
my_config.ini
User overrided config.
my_config.cached.ini
System file used for storing internal settings
app.log
Application log
docs/
Documentation
gui/
Contains GUI code
libs/
Internal and external libraries. External libraries are included in release
for compatibilty and ease of installation
config.py
Handle loading of configuration
data.py
Handles creation/manipulation of the data directory
gui.py
All gui code. To be divided up into plugins
logger.py
Logging code
protocols/
Contains protocol plugins for communicating with hardware
Released plugins include:
FreeEMS_Vanilla
Version 0.0.17
config.default.ini
Default configuration. Do not edit this file, but rather override settings in
data/my_config.ini - REMEMBER to include headings!! e.g. [Logging]
main.py
Boot/setup file
You many notice many *.pyc files appear, these are files generated by python to speed up the program,
you can safely ignore them. If they are deleted, python will regenerate them next time it is run.