Skip to content

Commit

Permalink
Squashed commit of the following:
Browse files Browse the repository at this point in the history
commit eff74e6
Author: Frédéric Metrich <[email protected]>
Date:   Thu May 30 09:27:57 2024 +0200

    Fix typo

commit 42da896
Author: Frédéric Metrich <[email protected]>
Date:   Fri Apr 19 06:55:34 2024 +0200

    Update documentation for Carte-relais pour sortie tout-ou-rien

commit eb3ee08
Author: Frédéric Metrich <[email protected]>
Date:   Sun Apr 14 11:52:43 2024 +0200

    Update documentation

commit 0c363e7
Author: Frédéric Metrich <[email protected]>
Date:   Fri Mar 29 19:35:29 2024 +0100

    Update Readme.md

    Signed-off-by: Frédéric Metrich <[email protected]>

commit 8913590
Author: Frédéric Metrich <[email protected]>
Date:   Tue Mar 26 09:55:56 2024 +0100

    Update documentation for ACI monophasée KITABLE and contacteur HC/HP

commit b0f0be1
Author: Frédéric Metrich <[email protected]>
Date:   Tue Mar 26 09:42:47 2024 +0100

    Update documentation for ACI monophasée KITABLE and contacteur HC/HP

commit 34dafad
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 24 12:40:28 2024 +0100

    Update documentation for ACI monophasée KITABLE and contacteur HC/HP

commit c5c3443
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 24 10:52:33 2024 +0100

    Update documentation for ACI monophasée KITABLE and contacteur HC/HP

commit d12997b
Author: Frédéric Metrich <[email protected]>
Date:   Sat Mar 23 17:43:09 2024 +0100

    Update documentation for ACI monophasée KITABLE and contacteur HC/HP

commit de19d26
Author: Frédéric Metrich <[email protected]>
Date:   Sat Mar 23 17:17:35 2024 +0100

    Refactor ACI monophasée KITABLE and contacteur HC/HP documentation

commit 4236d53
Author: Frédéric Metrich <[email protected]>
Date:   Fri Mar 22 23:28:43 2024 +0100

    Update documentation for ACI monophasée KITABLE and contacteur HC/HP

commit 47d759f
Author: Frédéric Metrich <[email protected]>
Date:   Tue Mar 19 22:26:24 2024 +0100

    Update type_traits.hpp

commit 49e30d0
Author: Frédéric Metrich <[email protected]>
Date:   Mon Mar 18 13:52:41 2024 +0100

    Fix DC offset calculation in processing.cpp

commit 3e4e999
Author: Frédéric Metrich <[email protected]>
Date:   Fri Mar 15 15:07:51 2024 +0100

    Some refactoring

commit 41b9ec6
Author: Frédéric Metrich <[email protected]>
Date:   Fri Mar 15 10:33:04 2024 +0100

    Fix platformio settings

commit 1e70fe2
Author: Frédéric Metrich <[email protected]>
Date:   Thu Mar 14 18:30:35 2024 +0100

    Some fixes

commit 6d1bb8c
Author: Frédéric Metrich <[email protected]>
Date:   Thu Mar 14 17:26:54 2024 +0100

    Some tiny refactoring

commit d34d9ab
Author: Frédéric Metrich <[email protected]>
Date:   Thu Mar 14 16:37:36 2024 +0100

    Doc reformulée avec la généreuse contribution de l'IA :D

commit f17c67d
Author: Frédéric Metrich <[email protected]>
Date:   Thu Mar 14 16:17:06 2024 +0100

    More doc

commit 7d07f91
Author: Frédéric Metrich <[email protected]>
Date:   Thu Mar 14 10:02:01 2024 +0100

    Some doc fix

commit b250d67
Author: Frédéric Metrich <[email protected]>
Date:   Thu Mar 14 08:46:10 2024 +0100

    Some doc

commit f1e487b
Author: Frédéric Metrich <[email protected]>
Date:   Thu Mar 14 07:18:38 2024 +0100

    Update Readme.md

    Signed-off-by: Frédéric Metrich <[email protected]>

commit fa87f08
Author: Frédéric Metrich <[email protected]>
Date:   Thu Mar 14 07:17:31 2024 +0100

    Update Readme.md

    Signed-off-by: Frédéric Metrich <[email protected]>

commit 884dc46
Author: Frédéric Metrich <[email protected]>
Date:   Thu Mar 14 07:16:46 2024 +0100

    Update Readme.md

    Signed-off-by: Frédéric Metrich <[email protected]>

commit b8c948e
Author: Frédéric Metrich <[email protected]>
Date:   Thu Mar 14 07:14:47 2024 +0100

    Update Readme.md

    Signed-off-by: Frédéric Metrich <[email protected]>

commit 95a03fb
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 23:53:49 2024 +0100

    Fix parameter

commit c23a6f8
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 23:49:06 2024 +0100

    Try with define

commit e690f89
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 23:25:20 2024 +0100

    Try another option

commit f022133
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 23:07:08 2024 +0100

    Revert not working option

commit 4faaae7
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 23:03:48 2024 +0100

    Try better template parsing

commit b08d716
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 22:51:40 2024 +0100

    Centralize defgroups

commit b173d9a
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 22:40:19 2024 +0100

    Fix doxyfile

commit 10cb40e
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 22:31:57 2024 +0100

    Make doxygen more verbose

commit 61acc00
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 22:22:39 2024 +0100

    Fix doc

commit 29d72ba
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 22:15:47 2024 +0100

    Fix doxygen

commit e9b70c9
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 22:12:22 2024 +0100

    Fix doc

commit 9b1587e
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 22:09:02 2024 +0100

    Fix doxygen groups

commit ec70ab2
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 22:05:57 2024 +0100

    Some doc tuning

commit eef1010
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 10 21:42:19 2024 +0100

    Some doc + TEMA

commit 5aa1365
Author: Frédéric Metrich <[email protected]>
Date:   Sat Mar 9 18:34:52 2024 +0100

    Fix ewma

commit 16e5ba4
Author: Frédéric Metrich <[email protected]>
Date:   Sat Mar 9 13:02:04 2024 +0100

    Squashed commit of the following:

    commit fb99ae1
    Author: Frédéric Metrich <[email protected]>
    Date:   Sat Mar 9 12:45:35 2024 +0100

        Add DEMA

    commit 52892c2
    Author: Frédéric Metrich <[email protected]>
    Date:   Fri Mar 8 12:42:21 2024 +0100

        Add parenthesis

    commit 843ad1c
    Merge: f817917 8ef9f7b
    Author: Frédéric Metrich <[email protected]>
    Date:   Fri Mar 8 12:41:28 2024 +0100

        Merge branch 'multi-relays' of https://github.com/FredM67/PVRouter-3-phase into multi-relays

    commit f817917
    Author: Frédéric Metrich <[email protected]>
    Date:   Fri Mar 8 12:39:40 2024 +0100

        Try DEMA

    commit 8ef9f7b
    Author: Frédéric Metrich <[email protected]>
    Date:   Thu Mar 7 21:53:34 2024 +0100

        Try double EWMA

    commit f9cfd64
    Merge: 685e204 d3bedad
    Author: Frédéric Metrich <[email protected]>
    Date:   Wed Mar 6 10:08:53 2024 +0100

        Merge branch 'multi-relays' of https://github.com/FredM67/PVRouter-3-phase into multi-relays

    commit 685e204
    Author: Frédéric Metrich <[email protected]>
    Date:   Wed Mar 6 10:08:49 2024 +0100

        Fix test

    commit d3bedad
    Author: Frédéric Metrich <[email protected]>
    Date:   Tue Mar 5 23:01:56 2024 +0100

        Some doc

    commit fcf91d3
    Author: Frédéric Metrich <[email protected]>
    Date:   Wed Feb 28 21:03:13 2024 +0100

        Fix links

    commit cdbd3e6
    Author: Frédéric Metrich <[email protected]>
    Date:   Wed Feb 28 20:59:52 2024 +0100

        Default readme to fr

    commit b334503
    Author: Frédéric Metrich <[email protected]>
    Date:   Wed Feb 28 20:39:10 2024 +0100

        Set default to no relay

    commit a8160a0
    Author: Frédéric Metrich <[email protected]>
    Date:   Wed Feb 28 15:02:38 2024 +0100

        Typo

    commit 47b9ebe
    Author: Frédéric Metrich <[email protected]>
    Date:   Wed Feb 28 14:57:37 2024 +0100

        Multi relays engine

    commit 26f896b
    Author: Frédéric Metrich <[email protected]>
    Date:   Mon Feb 26 16:12:32 2024 +0100

        Squashed commit of the following:

        commit c73c567
        Author: Frédéric Metrich <[email protected]>
        Date:   Mon Feb 26 11:11:24 2024 +0100

            Add some alias for type_trait

        commit eb53c16
        Author: Frédéric Metrich <[email protected]>
        Date:   Mon Feb 26 11:10:55 2024 +0100

            Update color in schematic

        commit eac769e
        Author: Frédéric Metrich <[email protected]>
        Date:   Thu Feb 15 21:29:47 2024 +0100

            Update Readme.md (#82)

        commit 82d84ee
        Author: Frédéric Metrich <[email protected]>
        Date:   Tue Feb 13 14:37:48 2024 +0100

            Added Thermostat_tri_HC.pdf

        commit fad5e19
        Author: Frédéric Metrich <[email protected]>
        Date:   Tue Feb 13 14:36:53 2024 +0100

            Update Thermostat_tri_HC.drawio

        commit f03b4ca
        Author: Frédéric Metrich <[email protected]>
        Date:   Mon Feb 12 11:07:04 2024 +0100

            WIP: 1772479 Fix mvAvg

        commit 5e5646a
        Author: Frédéric Metrich <[email protected]>
        Date:   Mon Feb 5 00:04:30 2024 +0100

            Update CodeQL

        commit 4684e01
        Author: Frédéric Metrich <[email protected]>
        Date:   Sun Feb 4 23:35:01 2024 +0100

            Upt readme

        commit d957494
        Author: Frédéric Metrich <[email protected]>
        Date:   Sun Feb 4 23:32:24 2024 +0100

            Try again

        commit 46884f3
        Author: Frédéric Metrich <[email protected]>
        Date:   Sun Feb 4 23:30:21 2024 +0100

            Try fix

        commit c7db21e
        Author: Frédéric Metrich <[email protected]>
        Date:   Sun Feb 4 23:28:09 2024 +0100

            Fix readme

        commit 248a89a
        Author: Frédéric Metrich <[email protected]>
        Date:   Sun Feb 4 23:23:14 2024 +0100

            Reorganize readmes

        commit fff68e0
        Author: Frédéric Metrich <[email protected]>
        Date:   Sun Feb 4 23:11:19 2024 +0100

            Fix branch name

        commit 656308b
        Author: Frédéric Metrich <[email protected]>
        Date:   Sun Feb 4 23:10:39 2024 +0100

            Fix filenames

        commit b911d8d
        Author: Frédéric Metrich <[email protected]>
        Date:   Sun Feb 4 23:08:55 2024 +0100

            Fix links

        commit 83d5591
        Author: Frédéric Metrich <[email protected]>
        Date:   Sun Feb 4 23:07:18 2024 +0100

            Multilinugal readme + more details

        commit 1772479
        Author: Frédéric Metrich <[email protected]>
        Date:   Fri Feb 2 11:39:13 2024 +0100

            Fix mvAvg

        commit 90204aa
        Author: Frédéric Metrich <[email protected]>
        Date:   Mon Jan 22 22:02:08 2024 +0100

            Fix relay template

        commit eef84ea
        Author: Frédéric Metrich <[email protected]>
        Date:   Mon Jan 22 16:36:28 2024 +0100

            Enhanced sliding average...

        commit 1ea9c53
        Author: Frédéric Metrich <[email protected]>
        Date:   Tue Nov 14 05:22:20 2023 +0100

            Reorganize folders

        commit 8522341
        Author: Frédéric Metrich <[email protected]>
        Date:   Tue Nov 14 05:20:39 2023 +0100

            Upd

        commit a6a660b
        Author: Frédéric Metrich <[email protected]>
        Date:   Wed Nov 8 23:11:58 2023 +0100

            Update Readme.md

        commit 145c86e
        Author: Frédéric Metrich <[email protected]>
        Date:   Mon Nov 6 09:13:08 2023 +0100

            Update Readme.md

        commit 4d0936b
        Author: Frédéric Metrich <[email protected]>
        Date:   Mon Nov 6 07:40:13 2023 +0100

            Update Readme.md

        commit 85910b9
        Author: Frédéric Metrich <[email protected]>
        Date:   Mon Nov 6 07:21:08 2023 +0100

            Update Readme.md

        commit efbda93
        Author: Frédéric Metrich <[email protected]>
        Date:   Mon Nov 6 07:19:52 2023 +0100

            Update Readme.md (#79)

        commit cfb0204
        Author: Frédéric Metrich <[email protected]>
        Date:   Wed Oct 4 07:58:16 2023 +0200

            Formatting

        commit e0cefcd
        Author: Frédéric Metrich <[email protected]>
        Date:   Thu Sep 21 17:29:28 2023 +0200

            Fix comment

        commit 0cf1661
        Author: Frédéric Metrich <[email protected]>
        Date:   Thu Sep 21 13:21:59 2023 +0200

            Update schema

    commit 839af94
    Author: Frédéric Metrich <[email protected]>
    Date:   Wed Sep 20 15:58:02 2023 +0200

        Move pin assignment to ctor

commit 182da5e
Author: Frédéric Metrich <[email protected]>
Date:   Fri Mar 8 12:38:20 2024 +0100

    Typos

commit 4f9d03f
Author: Frédéric Metrich <[email protected]>
Date:   Wed Mar 6 23:27:18 2024 +0100

    Typo

commit 7b1f003
Author: Frédéric Metrich <[email protected]>
Date:   Wed Mar 6 23:20:54 2024 +0100

    Some fixes

commit 2002945
Author: Frédéric Metrich <[email protected]>
Date:   Wed Mar 6 22:45:29 2024 +0100

    Fix naming

commit 23ff7dd
Author: Frédéric Metrich <[email protected]>
Date:   Wed Mar 6 22:27:37 2024 +0100

    Fix

commit 34d90f2
Author: Frédéric Metrich <[email protected]>
Date:   Wed Mar 6 22:26:53 2024 +0100

    Typo

commit aa208e3
Author: Frédéric Metrich <[email protected]>
Date:   Wed Mar 6 22:24:18 2024 +0100

    Some doc

commit 96c79fd
Author: Frédéric Metrich <[email protected]>
Date:   Wed Mar 6 22:15:48 2024 +0100

    More doc

commit 5956619
Author: Frédéric Metrich <[email protected]>
Date:   Wed Mar 6 21:42:54 2024 +0100

    More doc

commit 40a376f
Author: Frédéric Metrich <[email protected]>
Date:   Wed Mar 6 16:45:27 2024 +0100

    Better notes

commit 5555746
Merge: 66c68c1 472e4d1
Author: Frédéric Metrich <[email protected]>
Date:   Wed Mar 6 16:43:02 2024 +0100

    Merge branch 'main' of https://github.com/FredM67/PVRouter-3-phase

commit 66c68c1
Author: Frédéric Metrich <[email protected]>
Date:   Wed Mar 6 16:42:48 2024 +0100

    More doc

commit 472e4d1
Author: Frédéric Metrich <[email protected]>
Date:   Wed Mar 6 10:41:37 2024 +0100

    Fix log when sensor disconnected

commit 12a07cf
Author: Frédéric Metrich <[email protected]>
Date:   Sun Mar 3 15:20:23 2024 +0100

    Some optimizations

commit bf73705
Author: Frédéric Metrich <[email protected]>
Date:   Sat Mar 2 13:45:14 2024 +0100

    Fix doc

commit 866f94a
Author: Frédéric Metrich <[email protected]>
Date:   Sat Mar 2 13:38:46 2024 +0100

    Refactoring temp (#84)

    * Refactoring temp

    * Fix refactoring temperature

commit af1fe84
Author: Frédéric Metrich <[email protected]>
Date:   Fri Mar 1 08:33:35 2024 +0100

    Update Readme.fr.md (#83)

    Signed-off-by: Frédéric Metrich <[email protected]>

commit c73c567
Author: Frédéric Metrich <[email protected]>
Date:   Mon Feb 26 11:11:24 2024 +0100

    Add some alias for type_trait

commit eb53c16
Author: Frédéric Metrich <[email protected]>
Date:   Mon Feb 26 11:10:55 2024 +0100

    Update color in schematic

commit eac769e
Author: Frédéric Metrich <[email protected]>
Date:   Thu Feb 15 21:29:47 2024 +0100

    Update Readme.md (#82)

commit 82d84ee
Author: Frédéric Metrich <[email protected]>
Date:   Tue Feb 13 14:37:48 2024 +0100

    Added Thermostat_tri_HC.pdf

commit fad5e19
Author: Frédéric Metrich <[email protected]>
Date:   Tue Feb 13 14:36:53 2024 +0100

    Update Thermostat_tri_HC.drawio

commit f03b4ca
Author: Frédéric Metrich <[email protected]>
Date:   Mon Feb 12 11:07:04 2024 +0100

    WIP: 1772479 Fix mvAvg

commit 5e5646a
Author: Frédéric Metrich <[email protected]>
Date:   Mon Feb 5 00:04:30 2024 +0100

    Update CodeQL

commit 4684e01
Author: Frédéric Metrich <[email protected]>
Date:   Sun Feb 4 23:35:01 2024 +0100

    Upt readme

commit d957494
Author: Frédéric Metrich <[email protected]>
Date:   Sun Feb 4 23:32:24 2024 +0100

    Try again

commit 46884f3
Author: Frédéric Metrich <[email protected]>
Date:   Sun Feb 4 23:30:21 2024 +0100

    Try fix

commit c7db21e
Author: Frédéric Metrich <[email protected]>
Date:   Sun Feb 4 23:28:09 2024 +0100

    Fix readme

commit 248a89a
Author: Frédéric Metrich <[email protected]>
Date:   Sun Feb 4 23:23:14 2024 +0100

    Reorganize readmes

commit fff68e0
Author: Frédéric Metrich <[email protected]>
Date:   Sun Feb 4 23:11:19 2024 +0100

    Fix branch name

commit 656308b
Author: Frédéric Metrich <[email protected]>
Date:   Sun Feb 4 23:10:39 2024 +0100

    Fix filenames

commit b911d8d
Author: Frédéric Metrich <[email protected]>
Date:   Sun Feb 4 23:08:55 2024 +0100

    Fix links

commit 83d5591
Author: Frédéric Metrich <[email protected]>
Date:   Sun Feb 4 23:07:18 2024 +0100

    Multilinugal readme + more details

commit 1772479
Author: Frédéric Metrich <[email protected]>
Date:   Fri Feb 2 11:39:13 2024 +0100

    Fix mvAvg

commit 90204aa
Author: Frédéric Metrich <[email protected]>
Date:   Mon Jan 22 22:02:08 2024 +0100

    Fix relay template

commit eef84ea
Author: Frédéric Metrich <[email protected]>
Date:   Mon Jan 22 16:36:28 2024 +0100

    Enhanced sliding average...
  • Loading branch information
FredM67 committed May 31, 2024
1 parent eee38c2 commit 81a7bc4
Show file tree
Hide file tree
Showing 40 changed files with 2,061 additions and 677 deletions.
9 changes: 5 additions & 4 deletions Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ EXTRACT_ALL = YES
# be included in the documentation.
# The default value is: NO.

EXTRACT_PRIVATE = NO
EXTRACT_PRIVATE = YES

# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
Expand All @@ -488,7 +488,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.

EXTRACT_STATIC = NO
EXTRACT_STATIC = YES

# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
Expand Down Expand Up @@ -2177,6 +2177,7 @@ INCLUDE_FILE_PATTERNS =
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.

PREDEFINED = __cdecl= \
__DOXYGEN__ \
TEMP_SENSOR \
OFF_PEAK_TARIFF \
RF_PRESENT \
Expand Down Expand Up @@ -2369,7 +2370,7 @@ UML_LIMIT_NUM_FIELDS = 10
# The default value is: NO.
# This tag requires that the tag HAVE_DOT is set to YES.

TEMPLATE_RELATIONS = NO
TEMPLATE_RELATIONS = YES

# If the INCLUDE_GRAPH, ENABLE_PREPROCESSING and SEARCH_INCLUDES tags are set to
# YES then doxygen will generate a graph for each documented file showing the
Expand Down Expand Up @@ -2511,7 +2512,7 @@ PLANTUML_INCLUDE_PATH =
# Minimum value: 0, maximum value: 10000, default value: 50.
# This tag requires that the tag HAVE_DOT is set to YES.

DOT_GRAPH_MAX_NODES = 50
DOT_GRAPH_MAX_NODES = 200

# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the graphs
# generated by dot. A depth value of 3 means that only nodes reachable from the
Expand Down
4 changes: 2 additions & 2 deletions Mk2_3phase_RFdatalog_temp/Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -467,7 +467,7 @@ EXTRACT_ALL = YES
# be included in the documentation.
# The default value is: NO.

EXTRACT_PRIVATE = NO
EXTRACT_PRIVATE = YES

# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual
# methods of a class will be included in the documentation.
Expand All @@ -485,7 +485,7 @@ EXTRACT_PACKAGE = NO
# included in the documentation.
# The default value is: NO.

EXTRACT_STATIC = NO
EXTRACT_STATIC = YES

# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined
# locally in source files will be included in the documentation. If set to NO,
Expand Down
40 changes: 39 additions & 1 deletion Mk2_3phase_RFdatalog_temp/Mk2_3phase_RFdatalog_temp.ino
Original file line number Diff line number Diff line change
Expand Up @@ -140,11 +140,49 @@
* - heavy refactoring (again)
* - stl add-ons
* - add relay-output feature
*
* __February 2024: changes:__
* - refactoring of 'temperature feature'
* - refactoring of 'relay feature'
* - new sliding average (EWMA)
* - more documentation
*
* __March 2024: changes:__
* - multi-relay feature
* - add DEMA and TEMA sliding average
* - some tiny fixes
* - even more documentation
*
* @author Fred Metrich
* @copyright Copyright (c) 2023
* @copyright Copyright (c) 2024
*
*/

/*!
* @defgroup TimeCritical Time critical functions
* Functions used by the ISR
*/

/*!
* @defgroup RelayDiversion Relay diversion feature
* Functions used for the relay diversion
*/

/*!
* @defgroup TemperatureSensing Temperature sensing feature
* Functions used for the temperature sensing
*/

/*!
* @defgroup DualTariff Dual tariff feature
* Functions used for the dual tariff feature
*/

/*!
* @defgroup RF RF feature
* Functions used for the RF feature
*/

static_assert(__cplusplus >= 201703L, "**** Please define 'gnu++17' in 'platform.txt' ! ****");
static_assert(__cplusplus >= 201703L, "See also : https://github.com/FredM67/PVRouter-3-phase/blob/main/Mk2_3phase_RFdatalog_temp/Readme.md");

Expand Down
59 changes: 59 additions & 0 deletions Mk2_3phase_RFdatalog_temp/Readme.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
[![en](https://img.shields.io/badge/lang-en-red.svg)](Readme.en.md)
[![fr](https://img.shields.io/badge/lang-fr-blue.svg)](Readme.md)

This program is to be used with the Arduino IDE and/or other development IDE like VSCode + PlatformIO.

# Use with Arduino IDE

You'll need to download and install the **latest** [Arduino IDE](https://www.arduino.cc/en/software).

Download the "standalone" version, NOT the version from the Microsoft Store.
Pick-up the "Win 10 and newer, 64 bits" or the "MSI installer" version.

Since the code is optimized with the latest standard of C++, you'll need to edit a config file to activate C++17.

Please search the file '**platform.txt**' located in the installation path of the Arduino IDE.

For **Windows**, typically, you'll find the file in '**C:\Program Files (x86)\Arduino\hardware\arduino\avr**' and/or in '**%LOCALAPPDATA%\Arduino15\packages\arduino\hardware\avr\x.y.z**' where 'x.y.z' is the version of the **Arduino AVR Boards** package.

You can type this command in a Powershell : `Get-Childitem –Path C:\ -Include platform.txt -Recurse -ErrorAction SilentlyContinue`. It could take a couple of seconds/minutes until the file is found.

For **Linux**, if using the AppImage package, you'll find this file in '**~/.arduino15/packages/arduino/hardware/avr/1.8.6**'.
You can run `find / -name platform.txt 2>/dev/null` in case the location has been changed.

Edit the file in any Text Editor (you'll need **Admin rights**) and replace the parameter '**-std=gnu++11**' with '**-std=gnu++17**'. That's it!

If your Arduino IDE was opened, please close all the instances and open it again.

# Use with Visual Studio Code

You'll need to install additional extension(s). The most popular and used extensions for this job are '*Arduino*' and '*Platform IO*'.

# Quick overview of the files

- **Mk2_3phase_RFdatalog_temp.ino** : This file is needed for Arduino IDE
- **calibration.h** : contains the calibration parameters
- **config.h** : the user's preferences are stored here (pin assignments, features, ...)
- **config_system.h** : rarely modified system constants
- **constants.h** : some constants - *do not edit*
- **debug.h** : some macros for serial output and debugging
- **dualtariff.h** : definitions for the dual tariff feature
- **main.cpp** : source code
- **main.h** : functions prototypes
- **movingAvg.h** : source code for sliding-window average
- **processing.cpp** : source code for the processing engine
- **processing.h** : functions prototype of the processing engine
- **Readme.md** : this file
- **types.h** : definitions of types, ...
- **type_traits.h** : some STL stuff not yet available in the avr-package
- **type_traits** : folder containing some missing STL helpers
- **utils_relay.h** : source code for the *relay-diversion* feature
- **utils_rf.h** : source code for the *RF* feature
- **utils_temp.h** : source code for the *temperature* feature
- **utils.h** : helper functions and misc stuff
- **validation.h** : config validation, this code is executed during compile-time only !
- **platformio.ini** : PlatformIO configuration
- **inject_sketch_name.py** : helper script for PlatformIO
- **Doxyfile** : config for Doxygen (code documentation)

The end-user should ONLY edit both files **calibration.h** and **config.h**.
Loading

0 comments on commit 81a7bc4

Please sign in to comment.