From 36b52f0969983a2077500bea50f3ff8f63a89f1e Mon Sep 17 00:00:00 2001 From: Ali Jahangiri <75624145+aliphys@users.noreply.github.com> Date: Mon, 15 Aug 2022 19:03:12 +0200 Subject: [PATCH 01/11] Add compatible boards --- README.adoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 21601bb..36a2491 100644 --- a/README.adoc +++ b/README.adoc @@ -7,7 +7,10 @@ image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/ image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml"] image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"] -This library allows the control and configuration of the BQ24195 PMIC used on various Arduino boards. +This library allows the control and configuration of the BQ24195 PMIC used on various Arduino boards including: +- All MKR boards (apart from MKR 1000) +- Nano Motor Carrier +- Portenta Max Carrier The library is in beta and its APIs are not stable yet. From 333d5308b4cbfdc3ef87460bd0336b8ab87235a2 Mon Sep 17 00:00:00 2001 From: Ali Jahangiri <75624145+aliphys@users.noreply.github.com> Date: Mon, 15 Aug 2022 19:20:36 +0200 Subject: [PATCH 02/11] updated list --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 36a2491..3bc12e5 100644 --- a/README.adoc +++ b/README.adoc @@ -8,7 +8,7 @@ image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/ image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"] This library allows the control and configuration of the BQ24195 PMIC used on various Arduino boards including: -- All MKR boards (apart from MKR 1000) +- All MKR boards (apart from MKR 1000, Zero, WAN 1300 and Vidor 4000) - Nano Motor Carrier - Portenta Max Carrier From 7e623c071a61ad33bcc3bc9cfb55295c5b338adc Mon Sep 17 00:00:00 2001 From: Ali Jahangiri <75624145+aliphys@users.noreply.github.com> Date: Tue, 16 Aug 2022 10:38:52 +0200 Subject: [PATCH 03/11] Added exact board names --- README.adoc | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.adoc b/README.adoc index 3bc12e5..c64164f 100644 --- a/README.adoc +++ b/README.adoc @@ -7,10 +7,14 @@ image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/ image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml/badge.svg["Compile Examples status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/compile-examples.yml"] image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"] -This library allows the control and configuration of the BQ24195 PMIC used on various Arduino boards including: -- All MKR boards (apart from MKR 1000, Zero, WAN 1300 and Vidor 4000) -- Nano Motor Carrier -- Portenta Max Carrier +This library allows the control and configuration of the BQ24195 PMIC as part of the following Arduino boards: +- The following MKR boards + - MKR WIFI 1010 (SKU: ABX00023) + - MKR FOX 1200 (SKU: ABX00014) + - MKR GSM 1400 (SKU: ABX00018) + - MKR NB 1500 (SKU: ABX00019) +- Nano Motor Carrier (SKU: ABX00041) +- Portenta Max Carrier (SKU: ABX00043) The library is in beta and its APIs are not stable yet. From 280bf65e6b07abd181312069ddbe47d145106330 Mon Sep 17 00:00:00 2001 From: Ali Jahangiri <75624145+aliphys@users.noreply.github.com> Date: Tue, 16 Aug 2022 11:31:15 +0200 Subject: [PATCH 04/11] Fix ASCII doc rendering --- README.adoc | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.adoc b/README.adoc index c64164f..fc2f47c 100644 --- a/README.adoc +++ b/README.adoc @@ -8,12 +8,19 @@ image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/ image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml/badge.svg["Spell Check status", link="https://github.com/{repository-owner}/{repository-name}/actions/workflows/spell-check.yml"] This library allows the control and configuration of the BQ24195 PMIC as part of the following Arduino boards: + - The following MKR boards + - MKR WIFI 1010 (SKU: ABX00023) + - MKR FOX 1200 (SKU: ABX00014) + - MKR GSM 1400 (SKU: ABX00018) + - MKR NB 1500 (SKU: ABX00019) + - Nano Motor Carrier (SKU: ABX00041) + - Portenta Max Carrier (SKU: ABX00043) The library is in beta and its APIs are not stable yet. From 643830a87a73fcc94f35cd7f0b6147db6375cbec Mon Sep 17 00:00:00 2001 From: Ali Jahangiri <75624145+aliphys@users.noreply.github.com> Date: Tue, 16 Aug 2022 11:32:22 +0200 Subject: [PATCH 05/11] Fix sublist --- README.adoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.adoc b/README.adoc index fc2f47c..fdddceb 100644 --- a/README.adoc +++ b/README.adoc @@ -11,13 +11,13 @@ This library allows the control and configuration of the BQ24195 PMIC as part of - The following MKR boards - - MKR WIFI 1010 (SKU: ABX00023) +-- MKR WIFI 1010 (SKU: ABX00023) - - MKR FOX 1200 (SKU: ABX00014) +-- MKR FOX 1200 (SKU: ABX00014) - - MKR GSM 1400 (SKU: ABX00018) +-- MKR GSM 1400 (SKU: ABX00018) - - MKR NB 1500 (SKU: ABX00019) +-- MKR NB 1500 (SKU: ABX00019) - Nano Motor Carrier (SKU: ABX00041) From 0f21af4acbbc2518995c050d27a3042ce0e0bc3a Mon Sep 17 00:00:00 2001 From: Ali Jahangiri <75624145+aliphys@users.noreply.github.com> Date: Tue, 16 Aug 2022 11:33:24 +0200 Subject: [PATCH 06/11] Use * for list --- README.adoc | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/README.adoc b/README.adoc index fdddceb..dd83135 100644 --- a/README.adoc +++ b/README.adoc @@ -9,19 +9,13 @@ image:https://github.com/{repository-owner}/{repository-name}/actions/workflows/ This library allows the control and configuration of the BQ24195 PMIC as part of the following Arduino boards: -- The following MKR boards - --- MKR WIFI 1010 (SKU: ABX00023) - --- MKR FOX 1200 (SKU: ABX00014) - --- MKR GSM 1400 (SKU: ABX00018) - --- MKR NB 1500 (SKU: ABX00019) - -- Nano Motor Carrier (SKU: ABX00041) - -- Portenta Max Carrier (SKU: ABX00043) +* The following MKR boards +** MKR WIFI 1010 (SKU: ABX00023) +** MKR FOX 1200 (SKU: ABX00014) +** MKR GSM 1400 (SKU: ABX00018) +** MKR NB 1500 (SKU: ABX00019) +* Nano Motor Carrier (SKU: ABX00041) +* Portenta Max Carrier (SKU: ABX00043) The library is in beta and its APIs are not stable yet. From c68fb88d8f108c16fd3e523502d5ad919bc643ba Mon Sep 17 00:00:00 2001 From: Ali Jahangiri <75624145+aliphys@users.noreply.github.com> Date: Tue, 16 Aug 2022 19:49:48 +0200 Subject: [PATCH 07/11] Update README.adoc Co-authored-by: per1234 --- README.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/README.adoc b/README.adoc index dd83135..140153b 100644 --- a/README.adoc +++ b/README.adoc @@ -12,6 +12,7 @@ This library allows the control and configuration of the BQ24195 PMIC as part of * The following MKR boards ** MKR WIFI 1010 (SKU: ABX00023) ** MKR FOX 1200 (SKU: ABX00014) +** MKR GSM 1310 (SKU: MKRWAN1310WANT) ** MKR GSM 1400 (SKU: ABX00018) ** MKR NB 1500 (SKU: ABX00019) * Nano Motor Carrier (SKU: ABX00041) From c4b9d40cfd25843d70f3915b7848fc37fb0cb74d Mon Sep 17 00:00:00 2001 From: Ali Jahangiri <75624145+aliphys@users.noreply.github.com> Date: Tue, 16 Aug 2022 19:56:49 +0200 Subject: [PATCH 08/11] add wan to ignored words list --- .codespellrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.codespellrc b/.codespellrc index 101edae..49c3fe0 100644 --- a/.codespellrc +++ b/.codespellrc @@ -1,7 +1,7 @@ # See: https://github.com/codespell-project/codespell#using-a-config-file [codespell] # In the event of a false positive, add the problematic word, in all lowercase, to a comma-separated list here: -ignore-words-list = , +ignore-words-list = wan, check-filenames = check-hidden = skip = ./.git From bae8524d0bbb8aae942d678d3ce705286cc2f718 Mon Sep 17 00:00:00 2001 From: Ali Jahangiri <75624145+aliphys@users.noreply.github.com> Date: Tue, 16 Aug 2022 23:17:43 +0200 Subject: [PATCH 09/11] Update README.adoc Co-authored-by: per1234 --- README.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/README.adoc b/README.adoc index 140153b..81b1926 100644 --- a/README.adoc +++ b/README.adoc @@ -11,7 +11,6 @@ This library allows the control and configuration of the BQ24195 PMIC as part of * The following MKR boards ** MKR WIFI 1010 (SKU: ABX00023) -** MKR FOX 1200 (SKU: ABX00014) ** MKR GSM 1310 (SKU: MKRWAN1310WANT) ** MKR GSM 1400 (SKU: ABX00018) ** MKR NB 1500 (SKU: ABX00019) From 60f6aa73715dfe17eae14189e25508cdb118c9ef Mon Sep 17 00:00:00 2001 From: Ali Jahangiri <75624145+aliphys@users.noreply.github.com> Date: Wed, 17 Aug 2022 06:55:03 +0200 Subject: [PATCH 10/11] Correct MKR GSM 1310 SKU --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 81b1926..809a328 100644 --- a/README.adoc +++ b/README.adoc @@ -11,7 +11,7 @@ This library allows the control and configuration of the BQ24195 PMIC as part of * The following MKR boards ** MKR WIFI 1010 (SKU: ABX00023) -** MKR GSM 1310 (SKU: MKRWAN1310WANT) +** MKR GSM 1310 (SKU: ABX00029) ** MKR GSM 1400 (SKU: ABX00018) ** MKR NB 1500 (SKU: ABX00019) * Nano Motor Carrier (SKU: ABX00041) From 88001518a26020a53fde03b22e21dafd8cfc250e Mon Sep 17 00:00:00 2001 From: Ali Jahangiri <75624145+aliphys@users.noreply.github.com> Date: Wed, 17 Aug 2022 06:55:28 +0200 Subject: [PATCH 11/11] Correct MKR WAN 1310 name --- README.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.adoc b/README.adoc index 809a328..e9370a6 100644 --- a/README.adoc +++ b/README.adoc @@ -11,7 +11,7 @@ This library allows the control and configuration of the BQ24195 PMIC as part of * The following MKR boards ** MKR WIFI 1010 (SKU: ABX00023) -** MKR GSM 1310 (SKU: ABX00029) +** MKR WAN 1310 (SKU: ABX00029) ** MKR GSM 1400 (SKU: ABX00018) ** MKR NB 1500 (SKU: ABX00019) * Nano Motor Carrier (SKU: ABX00041)