Enedis
The configuration for the esthesis EDGE Enedis module consists of the following parameters.
General configuration
NAME | DESCRIPTION |
---|---|
ESTHESIS_EDGE_MODULES_ENEDIS_ENABLED --set esthesis.edge.modules.enedis.enabled | Whether the Enedis module is enabled or not. Default: false |
ESTHESIS_EDGE_MODULES_ENEDIS_CRON --set esthesis.edge.modules.enedis.cron | A Quartz-type cron expression, specifying the frequency in which the Enedis module tries to fetch data from the Enedis API. Default: 0 0 6 * * ? |
ESTHESIS_EDGE_MODULES_ENEDIS_MAX_DEVICES --set esthesis.edge.modules.enedis.maxDevices | The total number of Enedis devices that can be registered in esthesis EDGE. Default: 1000 |
ESTHESIS_EDGE_MODULES_ENEDIS_PAST_DAYS_INIT --set esthesis.edge.modules.enedis.pastDaysInit | The number of days in the past to fetch data from the Enedis API for a newly registered device. Default: 30 |
ESTHESIS_EDGE_MODULES_ENEDIS_CLIENT_ID --set esthesis.edge.modules.enedis.clientId | The client ID to use when connecting to the Enedis API. Default: esthesis-edge |
ESTHESIS_EDGE_MODULES_ENEDIS_CLIENT_SECRET --set esthesis.edge.modules.enedis.clientSecret | The client secret to use when connecting to the Enedis API. Default: esthesis-edge |
QUARKUS_REST_CLIENT_ENEDIS_CLIENT --set quarkus.restClient.EnedisClient | The URL of the Enedis API. Default: https://gw.ext.prod-sandbox.api.enedis.fr |
Data fetching
NAME | DESCRIPTION |
---|---|
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_DC_ENABLED --set esthesis.edge.modules.enedis.fetchTypes.dc.enabled | Enables fetching Daily Consumption data. Default: false |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_DC_CATEGORY --set esthesis.edge.modules.enedis.fetchTypes.dc.category | Category name when synchronising data. Default: energy |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_DC_MEASUREMENT --set esthesis.edge.modules.enedis.fetchTypes.dc.measurement | Measurement name when synchronising data. Default: dc |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_DC_ERRORS_THRESHOLD --set esthesis.edge.modules.enedis.fetchTypes.dc.errorsThreshold | The number of errors after which DC fetching is disabled for a device. Default: 10 |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_DCMP_ENABLED --set esthesis.edge.modules.enedis.fetchTypes.dcmp.enabled | Enables fetching Daily Consumption Max Power data. Default: false |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_DCMP_CATEGORY --set esthesis.edge.modules.enedis.fetchTypes.dcmp.category | Category name when synchronising data. Default: energy |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_DCMP_MEASUREMENT --set esthesis.edge.modules.enedis.fetchTypes.dcmp.measurement | Measurement name when synchronising data. Default: dcmp |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_DCMP_ERRORS_THRESHOLD --set esthesis.edge.modules.enedis.fetchTypes.dcmp.errorsThreshold | The number of errors after which DCMP fetching is disabled for a device. Default: 10 |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_DP_ENABLED --set esthesis.edge.modules.enedis.fetchTypes.dp.enabled | Enables fetching Daily Production data. Default: false |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_DP_CATEGORY --set esthesis.edge.modules.enedis.fetchTypes.dp.category | Category name when synchronising data. Default: energy |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_DP_MEASUREMENT --set esthesis.edge.modules.enedis.fetchTypes.dp.measurement | Measurement name when synchronising data. Default: dp |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_DP_ERRORS_THRESHOLD --set esthesis.edge.modules.enedis.fetchTypes.dp.errorsThreshold | The number of errors after which DP fetching is disabled for a device. Default: 10 |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_CLC_ENABLED --set esthesis.edge.modules.enedis.fetchTypes.clc.enabled | Enables fetching Consumption Load Curve data. Default: false |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_CLC_CATEGORY --set esthesis.edge.modules.enedis.fetchTypes.clc.category | Category name when synchronising data. Default: energy |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_CLC_MEASUREMENT --set esthesis.edge.modules.enedis.fetchTypes.clc.measurement | Measurement name when synchronising data. Default: clc |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_CLC_ERRORS_THRESHOLD --set esthesis.edge.modules.enedis.fetchTypes.clc.errorsThreshold | The number of errors after which CLC fetching is disabled for a device. Default: 10 |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_PLC_ENABLED --set esthesis.edge.modules.enedis.fetchTypes.plc.enabled | Enables fetching Production Load Curve data. Default: false |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_PLC_CATEGORY --set esthesis.edge.modules.enedis.fetchTypes.plc.category | Category name when synchronising data. Default: energy |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_PLC_MEASUREMENT --set esthesis.edge.modules.enedis.fetchTypes.plc.measurement | Measurement name when synchronising data. Default: plc |
ESTHESIS_EDGE_MODULES_ENEDIS_FETCH_TYPES_PLC_ERRORS_THRESHOLD --set esthesis.edge.modules.enedis.fetchTypes.plc.errorsThreshold | The number of errors after which PLC fetching is disabled for a device. Default: 10 |
Self-registration
NAME | DESCRIPTION |
---|---|
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_ENABLED --set esthesis.edge.modules.enedis.selfRegistration.enabled | Enables the self-registration page for Enedis' end-users. Default: false |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_STATE_CHECKING --set esthesis.edge.modules.enedis.selfRegistration.stateChecking | Enables checking the registration state when a user is redirected back from Enedis API to esthesis EDGE. Default: false |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_WELCOME_URL --set esthesis.edge.modules.enedis.selfRegistration.welcomeUrl | If set, instead of showing an internal self-registration page the user is redirected to this url. |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_REDIRECT_URL --set esthesis.edge.modules.enedis.selfRegistration.redirectUrl | The URL Enedis API is instructed to redirect the user after consent. Default: http://localhost:8080 |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_DURATION --set esthesis.edge.modules.enedis.selfRegistration.duration | The consent duration requested from Enedis API. Default: P1Y |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_LOGO1_URL --set esthesis.edge.modules.enedis.selfRegistration.page.logo1Url | The URL of the first logo to be displayed in the self-registration page. |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_LOGO1_ALT --set esthesis.edge.modules.enedis.selfRegistration.page.logo1Alt | The alt text of the first logo to be displayed in the self-registration page. |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_LOGO2_URL --set esthesis.edge.modules.enedis.selfRegistration.page.logo2Url | The URL of the second logo to be displayed in the self-registration page. |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_LOGO2_ALT --set esthesis.edge.modules.enedis.selfRegistration.page.logo2Alt | The alt text of the second logo to be displayed in the self-registration page. |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_LOGO3_URL --set esthesis.edge.modules.enedis.selfRegistration.page.logo3Url | The URL of the second logo to be displayed in the self-registration page. |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_LOGO3_ALT --set esthesis.edge.modules.enedis.selfRegistration.page.logo3Alt | The alt text of the third logo to be displayed in the self-registration page. |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_BUTTON_URL --set esthesis.edge.modules.enedis.selfRegistration.page.buttonUrl | The URL of the image being displayed on the Enedis forward button. |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_REGISTRATION_TITLE --set esthesis.edge.modules.enedis.selfRegistration.page.registration.title | The title of the self-registration page. Default: Connect your Enedis account |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_REGISTRATION_MESSAGE --set esthesis.edge.modules.enedis.selfRegistration.page.registration.message | The text of the self-registration page. Default: You will be redirected to Enedis, where you have to authenticate with your Enedis account, and authorise this application to retrieve your electricity consumption data. The authorisation will be valid for 1 year. Your data will be used by us to provide you with insights and recommendations on how to save energy. |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_SUCCESS_TITLE --set esthesis.edge.modules.enedis.selfRegistration.page.success.title | The title of the successful registration page. Default: Account connected |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_SUCCESS_MESSAGE --set esthesis.edge.modules.enedis.selfRegistration.page.success.message | The text of the successful registration page. Default: Your account was successfully connected, you may now close this window. |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_ERROR_TITLE --set esthesis.edge.modules.enedis.selfRegistration.page.error.title | The title of the unsuccessful registration page. Default: Error connecting account |
ESTHESIS_EDGE_MODULES_ENEDIS_SELF_REGISTRATION_PAGE_ERROR_MESSAGE --set esthesis.edge.modules.enedis.selfRegistration.page.error.message | The text of the unsuccessful registration page. Default: An error occurred while connecting your account. Please try again later. |