Skip to content
Newer
Older
100755 242 lines (168 sloc) 8.14 KB
e2fb7ce @stg README
authored Jun 15, 2012
1 DISK IMAGE MANAGER AND GUI FOR UPLOADING PATTERNS TO KNITTING MACHINES
cb975f8 @stg Better capability description
authored May 23, 2012
2
3 Machine capabilities:
5c5311e @stg Debug code removed, README update
authored Jun 15, 2012
4 * Brother Electroknit KH-950
47d3340 @stg MAJOR structural overhaul - prepared for multimachine support
authored May 23, 2012
5 * Brother Electroknit KH-940
5c5311e @stg Debug code removed, README update
authored Jun 15, 2012
6 * Brother Electroknit KH-930 BETA
cb975f8 @stg Better capability description
authored May 23, 2012
7 * ! Your machine here?
8 Help out the project! :)
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
9
9172f30 @stg README update with current information
authored Jul 4, 2012
10 Emulation capabilities:
11 * PDD1 floppy drive FDC emulation mode (limited)
12
13 Picture read capabilities:
14 * Recommended: 24-bit RGB - GIF, TIFF, PNG
15 * Any format supported by FreeImage
e2fb7ce @stg README
authored Jun 15, 2012
16
17 Software using library:
9172f30 @stg README update with current information
authored Jul 4, 2012
18 * Alternative OpenFrameworks GUI
e2fb7ce @stg README
authored Jun 15, 2012
19 See http://www.mcanet.info/patternUploader/ for information
20
9172f30 @stg README update with current information
authored Jul 4, 2012
21 Recognition:
22 * Thanks to Jonas Bengtsson for OSX support and binaries
23 * Thanks to Andrew Solomone for the full-color knitting style
24 * Thanks to Varvara Guljajeva and Mar Canet for inspiring the project
25 * Thanks to Steve Conklin for information provided at Antitronics
26 * GUI relies on SDL2 and FreeImage
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
27
3e87c8d @stg unnecessary windows binary stuff gone
authored May 31, 2012
28 == WINDOWS USERS =====================================================
29
30 Just download everything in the bin-win\ folder, put it anywhere you
31 like, then run gui.exe. This has everything you need to quickly get
32 patterns onto your machine.
33
9172f30 @stg README update with current information
authored Jul 4, 2012
34 == MAC USERS =========================================================
35
36 OSX binaries can be found in the bin-osx/ directory.
37 Jonas, would you like to put in a word here?
38
39 == LINUX USERS =======================================================
40
41 Linux binares can be found in the bin-linux/ directory.
42 This requires a modidifed SDL2 library to add xDnD support.
43 Tested under Ubuntu only.
44
45 Still no serial port detection effectively making the program useless
46 for linux at this point. HELP WANTED!
47
48 The modified SDL2 .so file must be placed in the library search path.
49 Sorry for this odd procedure. HELP WANTED!
50
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
51 == FILES =============================================================
52
47d3340 @stg MAJOR structural overhaul - prepared for multimachine support
authored May 23, 2012
53 bin-X/ Binaries/executables for operating system X
54 lib/ Source files for the disk image manager/emulator
55 cli/ Source files for command line interface
a217023 @stg minor
authored Jun 18, 2012
56 gui/ Source files for graphical user interface
47d3340 @stg MAJOR structural overhaul - prepared for multimachine support
authored May 23, 2012
57 doc/ File/memory layout description
58 ptn/ Sample patterns as both original bmp and raw
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
59
9172f30 @stg README update with current information
authored Jul 4, 2012
60 win-###-make.bat Build ###:cli/gui program (windows batch file)
61 linux-###.make.sh Build ###:cli/gui program (linux shell script)
62 osx-###.make.sh Build ###:cli/gui program (osx shell script)
63
64 Want to help out by creating makefiles? Let me know!
65
66 == HOW TO USE GUI UTILITY ============================================
67
68 Sorry, no proper documentation available at this point. HELP WANTED!
69
70 It is however fairly straight forward!
71
72 1) Install the application (os dependant process) and launch it.
73 2) Click FORMAT and select your machine
74 3) Drag pictures (24-bit GIF, PNG or TIFF) into the window
75 Make sure the pictures are of size STITCHESxROWS pixels.
76 Pictures with two colors will import as single color.
77 Pictures with different colors will import as multi or full color.
78 Multi-color: pictures with only one contrast color per row
79 Full-color: pictures with several colors on one or more rows
80 Full-color requires special stitching procedure
81 4) Verify import by clicking pattern in list on the left, then EDIT.
82 5) Click EMULATE and select the correct serial port in the list
83 6) Use the knitting machine to load from disk (track #1 only)
84
85 == HOW TO USE CLI UTILITY ============================================
cb975f8 @stg Better capability description
authored May 23, 2012
86
9172f30 @stg README update with current information
authored Jul 4, 2012
87 The CLI utility can be considered outdated, but is still useful when
88 you need to make patterns on a new machine and store them as a file
89 for analysis. The GUI does not provide this functionality.
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
90
91 Compile and launch knit executable.
92
93 Typing ? or help will give
94
af4edb1 @stg Added support for tracks (not tested)
authored May 21, 2012
95 ?/help show this
96 r/read read in data from file
97 w/write write out data to file
47d3340 @stg MAJOR structural overhaul - prepared for multimachine support
authored May 23, 2012
98 m/machine select knitting machine
af4edb1 @stg Added support for tracks (not tested)
authored May 21, 2012
99 f/format clear all tracks
100 t/track set working track
101 a/add add pattern to track
102 s/show display content of track
103 i/info additional track info
104 e/emulate emulate floppy
105 q/quit end program
106 x/halt halt on errors
107
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
108
109 read - Reads image on disk to memory
110 The file can be either disk image or folder with emulator files.
111
112 Entering the name of a file will read it as a disk image, ie:
113 filename> sample/1.img
114
115 Entering a folder name, ending with a (back)slash, will read
116 Tandy FDD1 emulator file folder, ie:
117 filename> fddemu/img/
118
119
120 write - Write memory to image on disk
121 The file can be either disk image or folder with emulator files.
122 See "read" command for more info.
123
124
47d3340 @stg MAJOR structural overhaul - prepared for multimachine support
authored May 23, 2012
125 machine - Select knitting machine
126 This will show the currently selected machine as well as list
127 the available/supported machines.
128
129 After listing, you are prompted to select a new machine and
130 this is selected by typing the short name of the machine
131 you wish to use, ie:
132 machine> kh940
133
134
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
135 format - Clear computer ram contents
136 This will delete everything currently contained in memory and
137 ready the program for input of a new file.
138
af4edb1 @stg Added support for tracks (not tested)
authored May 21, 2012
139
140 track - Set working track
141 The machine can store patterns in two separate tracks and this
142 is chosen when saving/loading from the machine.
143
144 This will sets the current working track for add, show and
145 info commands.
146
147 Tracks are entered as a number between 1 and 2, ie:
47d3340 @stg MAJOR structural overhaul - prepared for multimachine support
authored May 23, 2012
148 track> 1
af4edb1 @stg Added support for tracks (not tested)
authored May 21, 2012
149
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
150
151 add - Add a pattern to memory
af4edb1 @stg Added support for tracks (not tested)
authored May 21, 2012
152 The pattern is read from a raw image file, ie:
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
153 filename> patterns/903.raw
154
155 See doc\raw_format.txt for a description of the format.
156
157
158 show - Show patterns contained in memory
159 This will list all available patterns and to into pattern
160 display mode. In this mode you get the following promt:
1f2c29a @stg Some documentation additions/fixes
authored May 21, 2012
161
47d3340 @stg MAJOR structural overhaul - prepared for multimachine support
authored May 23, 2012
162 pattern>
1f2c29a @stg Some documentation additions/fixes
authored May 21, 2012
163
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
164 instead of the regular one.
165
166 To exit this mode enter d, done or simply enter a blank line.
167
168 While in this mode, enter the pattern number of an available
169 pattern to print out a graphical representation of the
c6c5963 @jonasb its not it's :-P
jonasb authored Jun 21, 2012
170 pattern as well as its binary data representation.
1f2c29a @stg Some documentation additions/fixes
authored May 21, 2012
171
172
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
173 info - Shows additional non-pattern information
174 This will display all important fields in the currently
175 loaded file and run a verification suite against all of
176 the know values.
177
178 Verifications are done against the most common and verified
179 to work values that have been downloaded from the machine.
180
181 Therefore it MAY give FAIL on "write pointer" entries and/or
1f2c29a @stg Some documentation additions/fixes
authored May 21, 2012
182 the "loaded head" entry for some files because the machine
183 sometimes inserts a 0x00 byte between patterns which causes
184 a mismatch of 1 for these values. Exactly when/why this is
185 done is uncertain, but it is not needed when writing patterns,
186 so it may actually be a bug in the machine.
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
187
188 Additionally, MOST parameters WILL give FAIL on a blank
189 formatted file, regardless if done via device or this
190 program.
191
192 For a file generated using this program all parameters
193 should give OK before attempting download.
194
195
af4edb1 @stg Added support for tracks (not tested)
authored May 21, 2012
196 emulate - Start floppy emulator
197
198 This will ask for a serial device and the format is different
199 depending on your system. For linux-flavors, it will usually
200 look like:
201 serial device> /dev/ttyS0
202
203 For windows, it will look something like:
204 serial device> COM1
205
206 After entering a serial device, the program will go into
207 floppy emulation mode.
208
209 You can exit this mode by sending a SIGINT, which is usually
210 Ctrl+C on most systems.
211
212 While in this mode, you can use the knitting machine to save
213 or load data into program memory, which can first be build
214 using add or read using read.
215
216 After saving from the machine you can keep it with write.
217
218
dc6ba06 @stg Fixed error in memory map documentation
authored May 18, 2012
219 quit - Self explanatory
a62d3f6 @stg Added halt on error for command line execution
authored May 18, 2012
220 Go outside and enjoy the weather
221
222 halt - Enable/disable halt on errors
223 Enabling halt on errors is good for command line execution
224
9172f30 @stg README update with current information
authored Jul 4, 2012
225 == CLI BATCH EXECUTION ===============================================
a62d3f6 @stg Added halt on error for command line execution
authored May 18, 2012
226
227 All commands can be executed from command line, for example:
228
47d3340 @stg MAJOR structural overhaul - prepared for multimachine support
authored May 23, 2012
229 knit x a ptn/tile.raw a ptn/inca.raw a ptn/text.raw w test.img q
a62d3f6 @stg Added halt on error for command line execution
authored May 18, 2012
230
231 Will do the following:
232
233 * Enable halt on error
234 * Add ptn/blocks.raw as #901
235 * Add ptn/inca.raw as #902
236 * Add ptn/text.raw as #903
47d3340 @stg MAJOR structural overhaul - prepared for multimachine support
authored May 23, 2012
237 * Write disk image to test.img
a62d3f6 @stg Added halt on error for command line execution
authored May 18, 2012
238 * Quit
239
240 In addition commands can also be piped in, or typed manually in
c6c5963 @jonasb its not it's :-P
jonasb authored Jun 21, 2012
241 succession at any prompt within the program.
Something went wrong with that request. Please try again.