diff options
author | Gerhard Sittig <gerhard.sittig@gmx.net> | 2020-08-12 18:48:27 +0200 |
---|---|---|
committer | Gerhard Sittig <gerhard.sittig@gmx.net> | 2020-08-12 20:18:10 +0200 |
commit | 82639220d4ca1d0eb24768f2d857b8f8183795fa (patch) | |
tree | 80821f7d613a798b0b78977cf58bf89251673203 | |
parent | b6975c680c337bce650eb785d3dad96c282726b6 (diff) | |
download | libsigrokdecode-82639220d4ca1d0eb24768f2d857b8f8183795fa.tar.gz libsigrokdecode-82639220d4ca1d0eb24768f2d857b8f8183795fa.zip |
sdq: provide more information in the decoder's boilerplate
Extend the __init__.py module's doc string. Provide more details to the
user beyond the vendor's name, to increase the decoder's usability.
-rw-r--r-- | decoders/sdq/__init__.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/decoders/sdq/__init__.py b/decoders/sdq/__init__.py index 7087bda..3fc1043 100644 --- a/decoders/sdq/__init__.py +++ b/decoders/sdq/__init__.py @@ -18,7 +18,11 @@ ## ''' -Texas Instruments SDQ protocol, also used by Apple. +The SDQ protocol was developed by Texas Instruments, and is used in +devices like battery pack authentication. Apple uses SDQ in MagSafe +and Lightning connectors, as well as some batteries. + +See https://www.ti.com/lit/ds/symlink/bq26100.pdf for details. ''' from .pd import Decoder |