Skip to content

Commit 668f5ff

Browse files
author
Alec Miller
committed
MPAE-4022: Updates to readme
1 parent f492d9b commit 668f5ff

File tree

2 files changed

+53
-1
lines changed

2 files changed

+53
-1
lines changed

images/platform.png

22.7 MB
Loading

readme.md

Lines changed: 53 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,17 +42,69 @@ with minimal
4242
- Curiosity Nano Base for Click boards™ [(AC164162)](https://www.microchip.com/Developmenttools/ProductDetails/AC164162)
4343
- POT Click board™ [(MIKROE-3402)](https://www.mikroe.com/pot-click) -->
4444

45+
<img src="images/platform.png" alt="Platform" width="600"/>
46+
47+
4548
- PIC18F57Q43 Curiosity Nano [(DM182029)](https://www.microchip.com/Developmenttools/ProductDetails/DM164150)
4649
- Curiosity Nano Base for Click boards™ [(AC164162)](https://www.microchip.com/Developmenttools/ProductDetails/AC164162)
4750
- 2x Stepper Click board™ [(MIKROE-3402)](https://www.mikroe.com/stepper-click)
51+
- 2 Axis CNC gantry - The code is designed to be flexible, such that it can
52+
be modified to work with almost any XY stepper gantry selected, provided
53+
the power requirements are not too great.
54+
- 2x Limit switches - Switches should be located such that they are pressed when
55+
the platform is at the (0, 0) position, and should be high when pressed.
56+
- 2x stepper motors - The motors used will depend on the gantry, ensure
57+
that they both move the end effector the same distance per tick, and must be
58+
2-pole (4 wire) to work with the Stepper Click board™
59+
- End Effector - Choice of end effector is likewise left flexible. As configured,
60+
the end effector selected should be raised when the pin controlling it is low,
61+
and lowered when the pin is high. This can be modified as needed to work with
62+
a selected end effector.
4863

4964
## Setup
5065

66+
Most configuration is done through the config.h file. The configurations are:
67+
68+
- TICKS_PER_METER: the number of steps of the stepper motor required to move the
69+
end effector one meter
70+
- X_MAX/YMAX: the maximum range, in steps, of the X and Y axes
71+
- X_BACKWARDS/Y_BACKWARDS: whether to reverse the direction of the stepper
72+
motor on this axis
73+
- BUFFER_NUMBER_PACKETS: the size of the command buffer. This can be left at the
74+
default 5
75+
76+
Pinout is defined with two constants, `NAME_PIN_PORT` and `NAME_PIN_POS`. To
77+
have pin Y_ENABLE on RA6, the code would be
78+
79+
```
80+
#define Y_ENABLE_PIN_PORT RA
81+
#define Y_ENABLE_PIN_POS 6
82+
```
83+
84+
As configured, the Y axis Stepper Click board™ should go in slot 1, and the x
85+
axis should be in slot 3.
86+
87+
By default the limit switch pin for the y axis is RA1, and the x axis is RC7.
88+
The actuator is on pin RF2.
89+
90+
If an alternate method of controlling the actuator is desired, the relevant
91+
functions are `Platform_RaiseActuator()` and `Platform_LowerActuator()` in
92+
platform.c which by default simply set ACTUATOR_PIN high/low.
93+
5194
<!-- Explain how to connect hardware and set up software. Depending on complexity, step-by-step instructions and/or tables and/or images can be used -->
5295

5396
## Operation
5497

55-
<!-- Explain how to operate the example. Depending on complexity, step-by-step instructions and/or tables and/or images can be used -->
98+
The CNC machine should be connected to the PC via USB. Operation of the PC
99+
control GUI is explained in detail in the readme file in the pc-application
100+
directory. An example G-Code that will draw a star is included in that
101+
directory.
102+
103+
For the purposes of creating G-Code, the machine operates in the x and y axis,
104+
with the location of the limit switches as (0, 0) and proceeding in the
105+
positive direction. A value of Z0 will cause the end effector to lower, any
106+
other value will cause it to raise. Operation is limited to linear movement.
107+
Movement in the Z axis and the X/Y plane simultaneously is not supported.
56108

57109
## Summary
58110

0 commit comments

Comments
 (0)