step_cl.cpp 10.3 KB
Newer Older
Jake Read's avatar
Jake Read committed
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
/*
osap/drivers/step_cl.cpp

stepper in closed loop mode 

Jake Read at the Center for Bits and Atoms
(c) Massachusetts Institute of Technology 2020

This work may be reproduced, modified, distributed, performed, and
displayed for any purpose, but must acknowledge the squidworks and ponyo
projects. Copyright is retained and must be preserved. The work is provided as
is; no warranty is provided, and users accept all liability.
*/

#include "step_cl.h"

Step_CL* Step_CL::instance = 0;

Step_CL* Step_CL::getInstance(void){
    if(instance == 0){
        instance = new Step_CL();
    }
    return instance;
}

Step_CL* step_cl = Step_CL::getInstance();

// https://github.com/cmaglie/FlashStorage
// flash LUT
// FlashStorage(flash_lut, step_cl_calib_table_t);
// float __attribute__((__aligned__(256))) lut[16384];

Step_CL::Step_CL(void){}

#define CALIB_CSCALE 0.4F
36
#define CALIB_STEP_DELAY 10
37
#define CALIB_SETTLE_DELAY 1
38
39
40
#define CALIB_SAMPLE_PER_TICK 10 

#define ENCODER_COUNTS 16384
Jake Read's avatar
Jake Read committed
41
42
43
44
45
46
47
48

void Step_CL::init(void){
    stepper_hw->init(false, 0.4);
    enc_as5047->init();
    // this lut == stored lut 
    //lut = flash_lut.read();
}

49
50
51
52
// das lut / flash stuff, 
// s/o to mechaduino code for this 
#define PAGE_SIZE 512 // start_flash_write reports this bit value, use datasheet 25.8.3 to reference 
const float __attribute__((__aligned__(PAGE_SIZE))) lut[ENCODER_COUNTS] = {};
53
54
55
const uint32_t start_addr = 0x10000000;
float temp_quad[4];
uint8_t temp_indice;
56

57
58
void flash_wait_ready(void){
    while(NVMCTRL->STATUS.bit.READY == 0);
59
60
}

61
62
63
64
65
// erase block at this addr 
void flash_erase_block(uint32_t *dst){
    flash_wait_ready();
    // do 'erase row'
    NVMCTRL->ADDR.reg = start_addr;//(uint32_t)dst;
66
    NVMCTRL->CTRLB.reg = NVMCTRL_CTRLB_CMDEX_KEY | NVMCTRL_CTRLB_CMD_EB;
67
    flash_wait_ready();
68
69
}

70
71
72
73
74
75
// writes blocks of four four bit words: i.e. 4 floats per row, 4 uint32, etc 
#define QUAD_WORD (4 * 4)
void flash_write_words(uint32_t *dst, uint32_t *src, uint32_t n_words){
    sysError("writing quad to addr: 0x" + String(dst[0], HEX));
    // set manuel page write 
    NVMCTRL->CTRLA.bit.WMODE = NVMCTRL_CTRLA_WMODE_MAN;
76

77
78
    // execute page buffer clear 
    flash_wait_ready();
79
    NVMCTRL->CTRLB.reg = NVMCTRL_CTRLB_CMDEX_KEY | NVMCTRL_CTRLB_CMD_PBC;
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
    flash_wait_ready();

    // write em ?
    while(n_words > 0){
        // more than 4 words left? 
        uint32_t len = 4 < n_words ? 4 : n_words;
        // write one quad word into page buffer (is ... the flash address?)
        for(uint32_t i = 0; i < 4; i ++){
            if(i < len){
                dst[i] = src[i];
            } else {
                dst[i] = 0xffffffff; // tail ends write to solid 1's 
            }
        }
        // erase the block 
        flash_erase_block(dst);
        // trigger the write 
        NVMCTRL->ADDR.reg = (uint32_t)dst;
        NVMCTRL->CTRLB.reg = NVMCTRL_CTRLB_CMDEX_KEY | NVMCTRL_CTRLB_CMD_WQW;
        // advance thru quad words 
        dst += len;
        src += len;
        n_words -= len;
103
    }
104
105
    sysError("quad complete");
    delay(10);
106
107
}

108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
// ok, I think I can try this: I keep a row of vals, 4 of 'em, then on wrap, I write 
// using erase / then write, using the lut as the start, 
// I'll try to do it once, to start, then read it out... 

void flash_write_init(void){
    temp_indice = 0;
}

void flash_write_value(float val){
    sysError("flt: " + String(val));
    temp_quad[temp_indice ++] = val;
    if(temp_indice > 3){
        flash_write_words((uint32_t *)lut, (uint32_t *)temp_quad, 4);
        temp_indice = 0; 
    }
123
124
125
}

// the calib routine 
126
127
128
boolean Step_CL::calibrate(void){
    // (1) first, build a table for 200 full steps w/ encoder averaged values at each step 
    float phase_angle = 0.0F;
Jake Read's avatar
Jake Read committed
129
    for(uint8_t i = 0; i < 200; i ++){ 
130
131
132
        // pt to new angle 
        stepper_hw->point(phase_angle, CALIB_CSCALE);
        // wait to settle / go slowly 
Jake Read's avatar
Jake Read committed
133
        delay(CALIB_STEP_DELAY);
134
135
136
137
138
139
140
141
142
143
144
        // do readings 
        float x = 0.0F;
        float y = 0.0F;
        for(uint8_t s = 0; s < CALIB_SAMPLE_PER_TICK; s ++){
            enc_as5047->trigger_read();
            while(!enc_as5047->is_read_complete()); // do this synchronously 
            float reading = enc_as5047->get_reading();
            x += cos((reading / (float)(ENCODER_COUNTS)) * 2 * PI);
            y += sin((reading / (float)(ENCODER_COUNTS)) * 2 * PI);
            // this is odd, I know, but it allows a new measurement to settle
            // so we get a real average 
145
            delay(CALIB_SETTLE_DELAY); 
146
147
148
149
150
151
152
153
        }
        // push reading, average removes the wraps added to readings. 
        calib_readings[i] = atan2(y, x);//(reading / (float)CALIB_SAMPLE_PER_TICK) - ENCODER_COUNTS;
        if(calib_readings[i] < 0) calib_readings[i] = 2 * PI + calib_readings[i]; // wrap the circle 
        calib_readings[i] = (calib_readings[i] * ENCODER_COUNTS) / (2 * PI);
        // rotate 
        phase_angle += 0.25F;
        if(phase_angle >= 1.0F) phase_angle = 0.0F;
Jake Read's avatar
Jake Read committed
154
    } // end measurement taking 
155
156
    // tack end-wrap together, to easily find the wrap-at-indice interval 
    calib_readings[200] = calib_readings[0];
Jake Read's avatar
Jake Read committed
157
    if(false){ // debug print intervals 
158
        for(uint8_t i = 0; i < 200; i ++){
159
160
161
162
163
            sysError("int: " + String(i) 
                        + " " + String(calib_readings[i], 4)
                        + " " + String(calib_readings[i + 1], 4));
            delay(2);
        }
Jake Read's avatar
Jake Read committed
164
    }
165
166
167
168
169
170
171
172
173
174
175
176
177
178
    // check sign of readings 
    // the sign will help identify the wrapping interval
    // might get unlucky and find the wrap, so take majority vote of three 
    boolean s1 = (calib_readings[1] - calib_readings[0]) > 0 ? true : false;
    boolean s2 = (calib_readings[2] - calib_readings[1]) > 0 ? true : false;
    boolean s3 = (calib_readings[3] - calib_readings[2]) > 0 ? true : false;
    boolean sign = false;
    if((s1 && s2) || (s2 && s3) || (s1 && s3)){
        sign = true;
    } else {
        sign = false;
    }
    sysError("calib sign: " + String(sign));

Jake Read's avatar
Jake Read committed
179
    // (2) build the table, walk all encoder counts... 
180
181
    // now to build the actual table... 
    // want to start with the 0 indice, 
182
183
    flash_write_init();
    for(uint16_t e = 0; e < 4; e ++){
Jake Read's avatar
Jake Read committed
184
185
        // find the interval that spans this sample
        boolean bi = false; 
186
        int16_t interval = -1;
187
        for(uint8_t i = 0; i < 200; i ++){
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
            if(sign){ // +ve slope readings, left < right 
                if(calib_readings[i] < e && e <= calib_readings[i + 1]){
                    interval = i;
                    break;
                }
            } else { // -ve slope readings, left > right 
                if(calib_readings[i] > e && e >= calib_readings[i + 1]){
                    interval = i;
                    break;
                }
            }
        }
        // log intervals 
        if(interval >= 0){
            // sysError(String(e) + " inter: " + String(interval) 
            //                 + " " + String(calib_readings[interval]) 
            //                 + " " + String(calib_readings[interval + 1]));
        } else {
206
            // no proper interval found, must be the bi 
207
            // find the opposite-sign interval 
208
            for(uint8_t i = 0; i < 200; i ++){
209
210
211
                boolean intSign = (calib_readings[i + 1] - calib_readings[i]) > 0 ? true : false;
                if(intSign != sign){
                    interval = i;
Jake Read's avatar
Jake Read committed
212
                    bi = true; // mark the bad interval
213
214
215
                    break;
                }
            }
Jake Read's avatar
Jake Read committed
216
217
218
219
220
221
            if(!bi){
                // truly strange 
                sysError("missing interval, exiting");
                return false;
            }
            /*
222
223
224
225
            sysError("bad interval at: " + String(e) 
                    + " " + String(interval)
                    + " " + String(calib_readings[interval]) 
                    + " " + String(calib_readings[interval + 1]));
Jake Read's avatar
Jake Read committed
226
            */
227
        }
228
229
230

        // (3) have the interval (one is bad), 
        // find real angles (ra0, ra1)
231
232
        float ra0 = 360.0F * ((float)interval / 200);          // real angle at left of interval 
        float ra1 = 360.0F * ((float)(interval + 1) / 200);    // real angle at right of interval 
233
234
235
236
237
238
        // interval spans these readings (er0, er1)
        float er0 = calib_readings[interval];
        float er1 = calib_readings[interval + 1];

        // (4) for the bad interval, some more work to do to modify interp. points 
        float spot = e;
Jake Read's avatar
Jake Read committed
239
        if(bi){
240
241
242
243
244
245
            if(sign){ // wrap the tail *up*, do same for pts past zero crossing 
                er1 += (float)ENCODER_COUNTS;
                if(spot < er0) spot += (float)ENCODER_COUNTS;
            } else { // wrap the tail *down*, do same for pts past zero crossing 
                er1 -= (float)ENCODER_COUNTS;
                if(spot > er0) spot -= (float)ENCODER_COUNTS;
Jake Read's avatar
Jake Read committed
246
247
            }
        }
248
249
250
251
252
253

        // (5) continue w/ (ra0, ra1) and (er0, er1) to interpolate for spot 
        // check we are not abt to div / 0: this could happen if motor did not turn during measurement 
        float intSpan = er1 - er0;
        if(intSpan < 0.01F && intSpan > -0.01F){
            sysError("near zero interval, exiting");
254
255
256
            return false;
        }
        // find pos. inside of interval 
257
        float offset = (spot - er0) / intSpan;
Jake Read's avatar
Jake Read committed
258
        // find real angle offset at e, modulo for the bad interval 
259
        float ra = (ra0 + (ra1 - ra0) * offset);
260
        // log those 
261
262
263
264
265
266
267
268
269
270
271
        if(false){
            if(bi){
                sysError("e: " + String(e) + " ra: " + String(ra, 4) + " BI");
                //     + " span: " + String(intSpan) + " offset: " + String(offset));
                // sysError("i0: " + String(interval) + " " + String(calib_readings[interval])
                //     + " i1: " + String(calib_readings[interval + 1])
                //     + " BI");
            } else {
                sysError("e: " + String(e) + " ra: " + String(ra, 4));
            }
            delay(10);            
Jake Read's avatar
Jake Read committed
272
        }
273
274
        // ok, have the real angle (ra) at the encoder tick (e), now write it 
        flash_write_value(ra); // this just happens in order, we zeroe'd out global counters at the start 
275
    } // end sweep thru 2^14 pts 
Jake Read's avatar
Jake Read committed
276
    sysError("calib complete");
277
    return true; // went OK 
278
279
280
}

void Step_CL::print_table(void){
281
    for(uint16_t e = 0; e < 4; e ++){
282
283
284
285
        float ra = lut[e];
        sysError("e: " + String(e) + " ra: " + String(ra, 4));
        delay(5);
    }
Jake Read's avatar
Jake Read committed
286
}