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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
|
#include "MCP4461.h"
/*
Library to control the MCP4461 Digital Potentiometer over I2C.
http://ww1.microchip.com/downloads/en/DeviceDoc/22265a.pdf
This library does not fully implement the functionality of
the MCP4461 just the basics of changing the wiper values.
Note this is currently configured to use the second I2C bus
on the Due: Wire1
The master joins the bus with the default address of 0
No warranty given or implied, use at your own risk.
Tony@think3dprint3d.com
GPL v3
*/
#include <stdio.h>
#include <Wire.h>
#ifdef DUET_NG
# define MCP_WIRE Wire
#else
# define MCP_WIRE Wire1
#endif
//ensure you call begin() before any other functions but note
//begin can only be called once for all MCP* objects as it initialises
//the local master through the Wire library
//if the MCP4461 does not have a default address, call set address before
//trying to communicate
MCP4461::MCP4461() {
_mcp4461_address = DEFAULT_ADDRESS;
}
//initialise the I2C interface as master ie local address is 0
void MCP4461::begin() {
MCP_WIRE.begin();
}
//set the MCP4461 address
void MCP4461::setMCP4461Address(uint8_t mcp4461_addr) {
_mcp4461_address = mcp4461_addr;
}
void MCP4461::setVolatileWiper(uint8_t wiper, uint16_t wiper_value){
uint16_t value = wiper_value;
if (value > 0xFF) value = 0x100;
uint8_t d_byte = (uint8_t)value;
uint8_t c_byte;
if (value > 0xFF)c_byte = 0x1; //the 8th data bit is 1
else c_byte =0;
switch (wiper) {
case 0:
c_byte |= MCP4461_VW0;
break;
case 1:
c_byte |= MCP4461_VW1;
break;
case 2:
c_byte |= MCP4461_VW2;
break;
case 3:
c_byte |= MCP4461_VW3;
break;
default:
break; //not a valid wiper
}
c_byte |= MCP4461_WRITE;
//send command byte
MCP_WIRE.beginTransmission(_mcp4461_address);
MCP_WIRE.write(c_byte);
MCP_WIRE.write(d_byte);
MCP_WIRE.endTransmission(); //do not release bus
}
void MCP4461::setNonVolatileWiper(uint8_t wiper, uint16_t wiper_value){
uint16_t value = wiper_value;
if (value > 0xFF) value = 0x100;
uint8_t d_byte = (uint8_t)value;
uint8_t c_byte;
if (value > 0xFF)c_byte = 0x1; //the 8th data bit is 1
else c_byte =0;
switch (wiper) {
case 0:
c_byte |= MCP4461_NVW0;
break;
case 1:
c_byte |= MCP4461_NVW1;
break;
case 2:
c_byte |= MCP4461_NVW2;
break;
case 3:
c_byte |= MCP4461_NVW3;
break;
default:
break; //not a valid wiper
}
c_byte |= MCP4461_WRITE;
//send command byte
MCP_WIRE.beginTransmission(_mcp4461_address);
MCP_WIRE.write(c_byte);
MCP_WIRE.write(d_byte);
MCP_WIRE.endTransmission(); //do not release bus
delay(20); //allow the write to complete (this is wasteful - better to check if the write has completed)
}
//set all the wipers in one transmission, more verbose but quicker than multiple calls to
//setVolatileWiper(uint8_t wiper, uint16_t wiper_value)
void MCP4461::setVolatileWipers(uint16_t wiper_value){
uint16_t value = wiper_value;
if (value > 0xFF) value = 0x100;
uint8_t d_byte = (uint8_t)value;
uint8_t c_byte;
if (value > 0xFF)c_byte = 0x1; //the 8th data bit is 1
else c_byte =0;
MCP_WIRE.beginTransmission(_mcp4461_address);
c_byte |= MCP4461_WRITE;
c_byte |= MCP4461_VW0;
MCP_WIRE.write(c_byte);
MCP_WIRE.write(d_byte);
if (value > 0xFF) c_byte = 0x1;
else c_byte =0;
c_byte |= MCP4461_WRITE;
c_byte |= MCP4461_VW1;
MCP_WIRE.write(c_byte);
MCP_WIRE.write(d_byte);
if (value > 0xFF) c_byte = 0x1;
else c_byte =0;
c_byte |= MCP4461_WRITE;
c_byte |= MCP4461_VW2;
MCP_WIRE.write(c_byte);
MCP_WIRE.write(d_byte);
if (value > 0xFF) c_byte = 0x1;
else c_byte =0;
c_byte |= MCP4461_WRITE;
c_byte |= MCP4461_VW3;
MCP_WIRE.write(c_byte);
MCP_WIRE.write(d_byte);
MCP_WIRE.endTransmission();
}
//set all the wipers in one transmission, more verbose but quicker than multiple calls to
//setNonVolatileWiper(uint8_t wiper, uint16_t wiper_value)
void MCP4461::setNonVolatileWipers(uint16_t wiper_value){
uint16_t value = wiper_value;
if (value > 0xFF) value = 0x100;
uint8_t d_byte = (uint8_t)value;
uint8_t c_byte;
if (value > 0xFF)c_byte = 0x1; //the 8th data bit is 1
else c_byte =0;
MCP_WIRE.beginTransmission(_mcp4461_address);
c_byte |= MCP4461_WRITE;
c_byte |= MCP4461_NVW0;
MCP_WIRE.write(c_byte);
MCP_WIRE.write(d_byte);
delay(20); //allow the write to complete (this is wasteful - better to check if the write has completed)
if (value > 0xFF) c_byte = 0x1;
else c_byte =0;
c_byte |= MCP4461_WRITE;
c_byte |= MCP4461_NVW1;
MCP_WIRE.write(c_byte);
MCP_WIRE.write(d_byte);
delay(20);
if (value > 0xFF) c_byte = 0x1;
else c_byte =0;
c_byte |= MCP4461_WRITE;
c_byte |= MCP4461_NVW2;
MCP_WIRE.write(c_byte);
MCP_WIRE.write(d_byte);
delay(20);
if (value > 0xFF) c_byte = 0x1;
else c_byte =0;
c_byte |= MCP4461_WRITE;
c_byte |= MCP4461_NVW3;
MCP_WIRE.write(c_byte);
MCP_WIRE.write(d_byte);
MCP_WIRE.endTransmission();
delay(20);
}
//return the value for a specific wiper
uint16_t MCP4461::getNonVolatileWiper(uint8_t wiper){
uint16_t ret = 0;
uint16_t c_byte =0;
switch (wiper) {
case 0:
c_byte |= MCP4461_NVW0;
break;
case 1:
c_byte |= MCP4461_NVW1;
break;
case 2:
c_byte |= MCP4461_NVW2;
break;
case 3:
c_byte |= MCP4461_NVW3;
break;
default:
return 0; //not a valid wiper
}
c_byte |= MCP4461_READ;
//send command byte
MCP_WIRE.beginTransmission(_mcp4461_address);
MCP_WIRE.write(c_byte);
MCP_WIRE.endTransmission(false); //do not release bus
MCP_WIRE.requestFrom((uint8_t)_mcp4461_address,(uint8_t)2);
//read the register
int i = 0;
while(MCP_WIRE.available())
{
ret |= MCP_WIRE.read();
if (i==0) ret = ret<<8;
i++;
}
return ret;
}
//return the volatile value for a specific wiper
uint16_t MCP4461::getVolatileWiper(uint8_t wiper){
uint16_t ret = 0;
uint16_t c_byte =0;
switch (wiper) {
case 0:
c_byte |= MCP4461_VW0;
break;
case 1:
c_byte |= MCP4461_VW1;
break;
case 2:
c_byte |= MCP4461_VW2;
break;
case 3:
c_byte |= MCP4461_VW3;
break;
default:
return 0; //not a valid wiper
}
c_byte |= MCP4461_READ;
//send command byte
MCP_WIRE.beginTransmission(_mcp4461_address);
MCP_WIRE.write(c_byte);
MCP_WIRE.endTransmission(false); //do not release bus
MCP_WIRE.requestFrom((uint8_t)_mcp4461_address,(uint8_t)2);
//read the register
int i = 0;
while(MCP_WIRE.available())
{
ret |= MCP_WIRE.read();
if (i==0) ret = ret<<8;
i++;
}
return ret;
}
//return the status register
uint16_t MCP4461::getStatus(){
uint16_t ret = 0;
uint16_t c_byte =0;
c_byte |= MCP4461_STATUS;
c_byte |= MCP4461_READ;
//send command byte
MCP_WIRE.beginTransmission(_mcp4461_address);
MCP_WIRE.write(c_byte);
MCP_WIRE.endTransmission(false); //do not release bus
MCP_WIRE.requestFrom((uint8_t)_mcp4461_address, (uint8_t)2);
//read the register
int i = 0;
while(MCP_WIRE.available())
{
ret |= MCP_WIRE.read();
if (i==0) ret = ret<<8;
i++;
}
return ret;
}
//toggle a specific pot channel on and off
/* //NOT YET IMPLEMENTED
void MCP4461::toggleWiper(uint8_t wiper){
uint16_t tcon = 0;
uint16_t c_byte =0;
//read the specific TCONX register to get the current stae of the
//pot connections
if (wiper <=1) {
c_byte |= MCP4461_TCON0;
c_byte |= MCP4461_READ;
}
else {
c_byte |= MCP4461_TCON1;
c_byte |= MCP4461_READ;
}
//send command byte
MCP_WIRE.beginTransmission(_mcp4461_address);
MCP_WIRE.write(c_byte);
MCP_WIRE.endTransmission(false); //do not release bus
MCP_WIRE.requestFrom((uint8_t)_mcp4461_address,(uint8_t)2);
//read the register
int i = 0;
while(MCP_WIRE.available())
{
tcon |= MCP_WIRE.read();
if (i==0) tcon = tcon<<8;
i++;
}
SerialUSB.print(" TCON ");
SerialUSB.print(tcon,BIN);
} */
|