Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Allow different types of write #55

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Allow different types of write #55

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions gatt/gatt_linux.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -596,21 +596,28 @@ def read_value(self, offset=0):
error = _error_from_dbus_error(e)
self.service.device.characteristic_read_value_failed(self, error=error)

def write_value(self, value, offset=0):
def write_value(self, value, offset=0, with_response=True):
"""
Attempts to write a value to the characteristic.

Success or failure will be notified by calls to `write_value_succeeded` or `write_value_failed` respectively.

:param value: array of bytes to be written
:param offset: offset from where to start writing the bytes (defaults to 0)
:param with_response: whether a response should be requested for the write (defaults to True)
"""
bytes = [dbus.Byte(b) for b in value]

if with_response == True:
write_type = "request"
else:
write_type = "command"

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

write_type = 'request' if with_response else 'command'

might be more appropriate here, or if more explicit code is preferred:

if with_response:
    write_type = 'request'
else:
    write_type = 'command'

try:
self._object.WriteValue(
bytes,
{'offset': dbus.UInt16(offset, variant_level=1)},
{'offset': dbus.UInt16(offset, variant_level=1),
'type': write_type},
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your PR! It's important that we don't break existing projects using this library. Since this parameter was previously not specified, what is the default value of type if omitted?

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I read the PR, the PR proposes the write_value() function to receive a new optional parameter with_response=True and thus existing code not providing that explicitly will get the default of True; in turn that will set write_type to "request" and that is then given to type if omitted.
So, that is the long story; and in short: existing code would with this PR default to 'type': "request" (as they will default to the with_response=True parameter.

reply_handler=self._write_value_succeeded,
error_handler=self._write_value_failed,
dbus_interface='org.bluez.GattCharacteristic1')
Expand Down