forked from parallaxinc/spin-standard-library
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsignal.adc.mcp320x.spin
181 lines (149 loc) · 5.81 KB
/
signal.adc.mcp320x.spin
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
{
---------------------------------------------------------------------------------------------------
Filename: signal.adc.mcp320x.spin
Description: Driver for Microchip MCP320x and 300x Analog to Digital Converters
Author: Jesse Burt
Started: Nov 26, 2019
Updated: Mar 2, 2024
Copyright (c) 2024 - See end of file for terms of use.
---------------------------------------------------------------------------------------------------
}
CON
{ default I/O settings; these can be overridden in the parent object }
CS = 0
SCK = 1
MOSI = 2
MISO = 3
MODEL = 3002
#include "signal.adc.common.spinh" ' pull in code common to all ADC drivers
VAR
long _CS
long _adc_ref
long _adc_rdbits, _adc_range, _adc_max
long _adc_model
word _adc_mask
byte _max_channels, _ch
OBJ
spi: "com.spi.1mhz"
core: "core.con.mcp320x"
time: "time"
u64: "math.unsigned64"
PUB null()
' This is not a top-level object
PUB start(): status
' Start the driver using default I/O settings
status := startx(CS, SCK, MOSI, MISO)
set_model(MODEL)
PUB startx(CS_PIN, SCK_PIN, MOSI_PIN, MISO_PIN): status
' Start the driver, using custom I/O settings
' CS_PIN: Chip Select
' SCK_PIN: Serial Clock
' MOSI_PIN: Master-Out Slave-In (ignored on single-channel ADC models)
' MISO_PIN: Master-In Slave-Out
' Returns: cog ID+1 of SPI engine on success, or 0 on failure
if ( lookdown(CS_PIN: 0..31) and lookdown(SCK_PIN: 0..31) and lookdown(MISO_PIN: 0..31) )
if ( status := spi.init(SCK_PIN, MOSI_PIN, MISO_PIN, core.SPI_MODE) )
time.msleep(1)
_CS := CS_PIN
outa[_CS] := 1
dira[_CS] := 1
defaults()
return status
' if this point is reached, something above failed
' Double check I/O pin assignments, connections, power
' Lastly - make sure you have at least one free core/cog
return FALSE
PUB stop()
' Stop the driver
spi.deinit()
_CS := 0
_adc_ref := 0
_ch := 0
PUB defaults()
' Factory defaults
set_model(3001)
set_adc_channel(0)
set_ref_voltage(3_300000)
PUB adc_channel(): ch
' Get currently set ADC channel (cached)
return _ch
PUB adc_data(): adc_word | cfg, len
' ADC data word
' Returns: ADC word (10 or 12 bits, depending on model - see set_model() )
case _max_channels
2:
cfg := core.START_MEAS_2CH | core.SINGLE_ENDED_2CH | (_ch << core.ODD_SIGN) | ...
core.MSBFIRST
len := 4
4, 8:
cfg := core.START_MEAS_4_8CH | core.SINGLE_ENDED_4_8CH | _ch
len := 5
outa[_CS] := 0
if ( _max_channels > 1 ) ' only multi-channel models are configurable
spi.wrbits_msbf(cfg, len) ' configure and initiate a conversion
adc_word := (spi.rdbits_msbf(_adc_rdbits) & _adc_mask)
outa[_CS] := 1
PUB adc2volts(adc_word): volts
' Scale ADC word to microvolts
return u64.multdiv(_adc_ref, adc_word, _adc_range)
PUB opmode(m)
' dummy method for API compatibility with other drivers
PUB ref_voltage(): v
' Get currently set reference voltage
' Returns: microvolts
return _adc_ref
PUB set_adc_channel(ch)
' Set ADC channel for subsequent reads
' Valid values: 0..7 (model-dependent)
_ch := 0 #> ch <# (_max_channels-1)
PUB set_adc_res(bits)
' Set ADC resolution
' Valid values: 10, 12 (other values ignored)
if ( lookdown(bits: 10, 12) )
_adc_rdbits := bits
_adc_range := (1 << bits) ' ADC max number of codes
_adc_max := _adc_range-1 ' ADC max word
_adc_mask := _adc_range-1 ' ADC word mask
pub set_model(m): e | tmp
' Set ADC model
' Valid values:
' 10-bit models: 3001, 3002, 3004, 3008
' 12-bit models: 3201, 3202, 3204, 3208
' Returns: 0 on success, -1 on invalid model
e := 0
case m
3001, 3002, 3004, 3008:
set_adc_res(10)
_max_channels := m-3000
3201, 3202, 3204, 3208:
set_adc_res(12)
_max_channels := m-3200
other:
return -1 ' error: invalid
if ( _max_channels == 1 )
_adc_rdbits += 3 ' data bits + null bit + 2 extra sample clocks
elseif ( _max_channels == 2 )
_adc_rdbits += 1 ' data bits + null bit
elseif ( _max_channels => 4 )
_adc_rdbits += 2 ' data bits + null bit + 1 extra sample clock
_adc_model := m
PUB set_ref_voltage(v): curr_v
' Set ADC reference/supply voltage (Vdd), in microvolts
' Valid values: 2_700_000..5_500_000 (2.7 .. 5.5V)
_adc_ref := (2_700000 #> v <# 5_500000)
DAT
{
Copyright 2024 Jesse Burt
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
associated documentation files (the "Software"), to deal in the Software without restriction,
including without limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or
substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT
OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
}