Skip to content

Commit 90bccef

Browse files
bessmanAlexander Bessman
authored andcommitted
Clarify that return value from I2C start/restart is ACK/NACK
1 parent 109d6d0 commit 90bccef

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

pslab/bus/i2c.py

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,8 @@ def _start(self, address: int, mode: int) -> int:
136136
137137
Returns
138138
-------
139-
response : int
140-
Response from I2C slave device.
139+
ackstat : int
140+
ACK (0) or NACK (1) from addressed peripheral.
141141
"""
142142
if self._mode == mode:
143143
return self._ACK
@@ -146,11 +146,12 @@ def _start(self, address: int, mode: int) -> int:
146146
secondary = CP.I2C_START if not self._running else CP.I2C_RESTART
147147
self._device.send_byte(secondary)
148148
self._device.send_byte((address << 1) | mode)
149-
response = self._device.get_ack() >> 4 # ACKSTAT
149+
response = self._device.get_ack()
150+
ackstat = response >> 4
150151
self._running = True
151152
self._mode = mode
152153

153-
return response
154+
return ackstat
154155

155156
def _restart(self, address: int, mode: int) -> int:
156157
"""Send repeated start.
@@ -167,17 +168,18 @@ def _restart(self, address: int, mode: int) -> int:
167168
168169
Returns
169170
-------
170-
response : int
171-
Response from I2C slave device.
171+
ackstat : int
172+
ACK (0) or NACK (1) from addressed peripheral.
172173
"""
173174
self._device.send_byte(CP.I2C_HEADER)
174175
self._device.send_byte(CP.I2C_RESTART)
175176
self._device.send_byte((address << 1) | mode)
176-
response = self._device.get_ack() >> 4 # ACKSTAT
177+
response = self._device.get_ack()
178+
ackstat = response >> 4
177179
self._running = True
178180
self._mode = mode
179181

180-
return response
182+
return ackstat
181183

182184
def _stop(self):
183185
"""Stop I2C transfer."""

0 commit comments

Comments
 (0)