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