From 82639220d4ca1d0eb24768f2d857b8f8183795fa Mon Sep 17 00:00:00 2001 From: Gerhard Sittig Date: Wed, 12 Aug 2020 18:48:27 +0200 Subject: 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. --- decoders/sdq/__init__.py | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) (limited to 'decoders/sdq') 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 -- cgit v1.2.3-70-g09d2