Update README.md #1
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Corrected a few typos and added a sentence explaining why JRE is needed
tropxy
reviewed
Dec 3, 2021
|
|
||
| ## How to fire it up :fire: | ||
|
|
||
| The 15118 -2 and -20 code live under the directory `iso15118`. | ||
| The ISO 15118 -2 and -20 code lives in the directory `iso15118`. |
There was a problem hiding this comment.
I was considering the plural as 15118-2 and -20 are 2 things and not 1, so they "live" and not it "lives"
There was a problem hiding this comment.
That doesn't sound right, if you wrote "code repositories" or something that would sound better. I'd leave it with "lives"
There was a problem hiding this comment.
but here we were talking about the two pieces of code which live in the same repo. I guess it doesnt sound that good for you, because "code" plural form is also "code" and we are used to use the singular form, i.e. "the code lives".
Anyway, it is just a small semantics/grammar detail and we are writing code, not an article or a novel 🙃
tropxy
reviewed
Dec 3, 2021
README.md
Outdated
| @@ -39,7 +39,9 @@ There are two recommended ways of running the project: | |||
| apt update && apt install -y default-jre | |||
|
|
|||
| ``` | |||
| Install the module using `poetry` and running the main script related | |||
| The JRE engine is only a temporary requirement until we replace the Java-based EXI codec (EXIficient) with our own RUST-based EXI codec. | |||
There was a problem hiding this comment.
if the Exificient is mentioned, can we add a link for it?
tropxy
reviewed
Dec 3, 2021
| The primary dependencies to install the project are the following: | ||
|
|
||
| > - Linux Distro (Non-Linux Systems are not supported) | ||
| > - Poetry [^3] | ||
| > - Python >= 3.7 | ||
|
|
||
| Also, since the project depends on external custom packages, it is necessary | ||
| to set the credentials for Switch PYPI server as ENVs: | ||
| to set the credentials for the Switch PYPI server as ENVs: |
There was a problem hiding this comment.
wouldnt Switch Pypi be qualified as a proper noun and therefore we can omit its use?
There was a problem hiding this comment.
It's "for the server", not "for server", no matter if you name the server with "Switch PyPi". There must be an article
MarcMueltin
pushed a commit
that referenced
this pull request
Jan 4, 2022
…s to implement the -20 states until ScheduleExchange. Update README.md (#1) * Update README.md Corrected a few typos and added a sentence explaining why JRE is needed * Update README.md * Update README.md * Update README.md Removed mqtt api as dependency (#3) Fix compatibility with linux (#2) * Added ipv6 support in docker world; fixed compatibility issue with sed between BSD and Linux systems * improved readme * renamed the .env files to be more intuitive in regards to their purpose; Updated Readme, adding a more detailed explanation of how to handle IPv6 communication within docker; fixed a bug on handling the configuration of the NIC interface * fixed bug in the host mode compose file * Added a few more clarification in the build Makefile recipe * Fixed language typos in the README and removed references to the MQTT api * Refactored network tools methods and general handling of it, to be more consise and close to the use case we have. For example, as the NETWORK_INTERFACE is always present, there is no need to scan for all the available interfaces to find one that contains a link-local address. * Removed references ot the PYPI credentials in the Dockerfile * Fixed bug on printing the interface used * addressed editorial comments and renamed exception to be consistent * Fixed docstring typo * Due to the changes regarding the handling of the exceptions of the code, I did some reworking on the UDP client and server services, as in some occasions (e.g. when the interface configured was invalid) the application would throw the error 'evcc_1 | sys:1: RuntimeWarning: coroutine 'CommunicationSessionHandler.get_from_rcv_queue' was never awaited evcc_1 | RuntimeWarning: Enable tracemalloc to get the object allocation traceback evcc_1 | sys:1: RuntimeWarning: coroutine 'CommunicationSessionHandler.restart_sdp' was never awaited evcc_1 | RuntimeWarning: Enable tracemalloc to get the object allocation traceback' * improved docs * fixed grammar and context * removed more PYPI references * fixed bug on EVCC side when requesting to stop charging Simplification of the Authorization process_message method (#5) * Removed explicit call to process CharParameterDiscoveryReq message; instead we can just decide which is the next expected state * Updated README and Authoruzation docstring * converted the wanring to a TODO improved secc and evcc configuration handling and updated readme (#6) * improved secc configuration handling and updated readme * Added configuration handling for the evcc * Refactored the collection of shared settings and log configuration. Also provided a way to select the location of the PKI certificate structure directory * Added new line at the end * improved README * minor editorial change Fix 1090 physical types validation error (#7) * Fixed max value validation for the PhysicalValue types * Changed multiplier to test the changes * On favour of DRY, I moved the root_validator of the PhysicalTypes to their parent class * added extra comment related to the private method validation with pydantic * changed physical value restrictions after comments by Marc * Revert "changed physical value restrictions after comments by Marc" This reverts commit cf88330. * used the enums for a few fields Github actions workflow and reformat of the code (#8) * Added github workflows for testing and publish; Reformatted the code using black and updated the CHANGELOG * Added initial tests * reformatted tests * typo * install with pip * attempt to run tests without poetry * added pytest to the workflow * suspended temporarily the tests run * fixed typo * re-added poetry to call black * added iso15118 for black * attempt to run tests (using docker) * copied tests dir to the container * retry poetry tests * added init to iso15118 dir * docker as testing stage * try to run tests with poetry again * run tests with docker * typo on the github action tag * Editorial change Added the skeleton for the remaining states (message handling classes) on the SECC side Added the skeleton for the remaining states (message handling classes) on the EVCC side Minor editorial edits and deactivating PnC in the settings to test EIM implementation first Fixed the list issues regarding the EXI codec as raised by Shalin for the AuthorizationReq message and CertificateInstallationReq message Implemented AuthorizationReq for EVCC and SECC Modified exi_codec to complete the list of ISO 15118-20 messages that shall be used to parse an object from an incoming decoded EXI stream. Implemented ServiceDiscoveryReq and -Res Implemented ServiceDetailReq and -Res Implemented ServiceSelectionReq and -Res Changed settings.py in shared directory as ROOT_DIR did not point to the actual root directory but to settings.py in the shared folder, which messed up the path to the pki folder. As a result, the ssl_context could not be created. Minor editorial edits and bugfix to get the application to run again Made use of the new enums INT_16_MIN, INT_16_MAX, INT_8_MIN, INT_8_MAX in common_messages.py and common_types.py Made use of the new enums INT_16_MAX in evcc_settings.py. Plus minor editorial edits to respect column length of 88 Added the specific payload type for each V2GTP message the EVCC and SECC sends in ISO 15118-20. In -20, we have energy mode-specific payload types we need to distinguish so that the EXI decoder gets pointed to the right XSD to decode the message. Added the failed response for DCChargeParameterDiscoveryReq and modified the failed_responses.py to return also the payload type, which is important for the EXI codec (as in -20, we have energy mode-specific payload types). Improved implementation of the class ServiceSelection on EVCC and SECC side Implemented class DCChargeParameterDiscovery on SECC side Fixed a small bug after changing the signature of the EVCC interface's get_charge_params_v20() function Improved implementation of ServiceDiscovery and ServiceDetails in order to better handle the offered and selected service and their associated parameter sets. Needed some changes in the comm_session.py and comm_session_handler.py (both EVCC and SECC) as well as the state classes. Working on finishing the implementation of the class DC_ChargeParameterDiscovery on the EVCC side. Implementing the ScheduleExchangeReq message. Changed the implementation of the selected energy service and selected value-added services as session variables in the comm_session object. This way, we have easier access to the various service parameters, especially useful for the selected energy service. Applied ge and le restrictions to departure_time and added the missing fields ev_max_v2x_energy_request and ev_min_v2x_energy_request to the class DynamicScheduleExchangeReqParams Finished implementing state DCChargeParameterDiscovery on the EVCC side Improved/fixed the implementation of class ServiceSelection on SECC side to check if the EVCC selected the correct pairs of service ID and parameter set ID per selected service Introduced NumericID type in common_types.py and replaced simple int types for schedules IDs etc. with that type. Also changed the name of the class ListOfRootCertificateIDs to RootCertificateIDList to be consistent with the latest changes coming with PR#4 Started implememting the class ScheduleExchange on the SECC side, which includes work on the get_scheduled_se_params() and get_dynamic_se_params() functions on the EVCC and SECC side. Finished implememting the class ScheduleExchange on the SECC side Ran black on the files in this branch Ran flake8 on the files in this branch Forgot to add evcc_state.py to my last commit
shalinnijel2
pushed a commit
that referenced
this pull request
Apr 19, 2022
…s to implement the -20 states until ScheduleExchange. Update README.md (#1) * Update README.md Corrected a few typos and added a sentence explaining why JRE is needed * Update README.md * Update README.md * Update README.md Removed mqtt api as dependency (#3) Fix compatibility with linux (#2) * Added ipv6 support in docker world; fixed compatibility issue with sed between BSD and Linux systems * improved readme * renamed the .env files to be more intuitive in regards to their purpose; Updated Readme, adding a more detailed explanation of how to handle IPv6 communication within docker; fixed a bug on handling the configuration of the NIC interface * fixed bug in the host mode compose file * Added a few more clarification in the build Makefile recipe * Fixed language typos in the README and removed references to the MQTT api * Refactored network tools methods and general handling of it, to be more consise and close to the use case we have. For example, as the NETWORK_INTERFACE is always present, there is no need to scan for all the available interfaces to find one that contains a link-local address. * Removed references ot the PYPI credentials in the Dockerfile * Fixed bug on printing the interface used * addressed editorial comments and renamed exception to be consistent * Fixed docstring typo * Due to the changes regarding the handling of the exceptions of the code, I did some reworking on the UDP client and server services, as in some occasions (e.g. when the interface configured was invalid) the application would throw the error 'evcc_1 | sys:1: RuntimeWarning: coroutine 'CommunicationSessionHandler.get_from_rcv_queue' was never awaited evcc_1 | RuntimeWarning: Enable tracemalloc to get the object allocation traceback evcc_1 | sys:1: RuntimeWarning: coroutine 'CommunicationSessionHandler.restart_sdp' was never awaited evcc_1 | RuntimeWarning: Enable tracemalloc to get the object allocation traceback' * improved docs * fixed grammar and context * removed more PYPI references * fixed bug on EVCC side when requesting to stop charging Simplification of the Authorization process_message method (#5) * Removed explicit call to process CharParameterDiscoveryReq message; instead we can just decide which is the next expected state * Updated README and Authoruzation docstring * converted the wanring to a TODO improved secc and evcc configuration handling and updated readme (#6) * improved secc configuration handling and updated readme * Added configuration handling for the evcc * Refactored the collection of shared settings and log configuration. Also provided a way to select the location of the PKI certificate structure directory * Added new line at the end * improved README * minor editorial change Fix 1090 physical types validation error (#7) * Fixed max value validation for the PhysicalValue types * Changed multiplier to test the changes * On favour of DRY, I moved the root_validator of the PhysicalTypes to their parent class * added extra comment related to the private method validation with pydantic * changed physical value restrictions after comments by Marc * Revert "changed physical value restrictions after comments by Marc" This reverts commit cf88330. * used the enums for a few fields Github actions workflow and reformat of the code (#8) * Added github workflows for testing and publish; Reformatted the code using black and updated the CHANGELOG * Added initial tests * reformatted tests * typo * install with pip * attempt to run tests without poetry * added pytest to the workflow * suspended temporarily the tests run * fixed typo * re-added poetry to call black * added iso15118 for black * attempt to run tests (using docker) * copied tests dir to the container * retry poetry tests * added init to iso15118 dir * docker as testing stage * try to run tests with poetry again * run tests with docker * typo on the github action tag * Editorial change Added the skeleton for the remaining states (message handling classes) on the SECC side Added the skeleton for the remaining states (message handling classes) on the EVCC side Minor editorial edits and deactivating PnC in the settings to test EIM implementation first Fixed the list issues regarding the EXI codec as raised by Shalin for the AuthorizationReq message and CertificateInstallationReq message Implemented AuthorizationReq for EVCC and SECC Modified exi_codec to complete the list of ISO 15118-20 messages that shall be used to parse an object from an incoming decoded EXI stream. Implemented ServiceDiscoveryReq and -Res Implemented ServiceDetailReq and -Res Implemented ServiceSelectionReq and -Res Changed settings.py in shared directory as ROOT_DIR did not point to the actual root directory but to settings.py in the shared folder, which messed up the path to the pki folder. As a result, the ssl_context could not be created. Minor editorial edits and bugfix to get the application to run again Made use of the new enums INT_16_MIN, INT_16_MAX, INT_8_MIN, INT_8_MAX in common_messages.py and common_types.py Made use of the new enums INT_16_MAX in evcc_settings.py. Plus minor editorial edits to respect column length of 88 Added the specific payload type for each V2GTP message the EVCC and SECC sends in ISO 15118-20. In -20, we have energy mode-specific payload types we need to distinguish so that the EXI decoder gets pointed to the right XSD to decode the message. Added the failed response for DCChargeParameterDiscoveryReq and modified the failed_responses.py to return also the payload type, which is important for the EXI codec (as in -20, we have energy mode-specific payload types). Improved implementation of the class ServiceSelection on EVCC and SECC side Implemented class DCChargeParameterDiscovery on SECC side Fixed a small bug after changing the signature of the EVCC interface's get_charge_params_v20() function Improved implementation of ServiceDiscovery and ServiceDetails in order to better handle the offered and selected service and their associated parameter sets. Needed some changes in the comm_session.py and comm_session_handler.py (both EVCC and SECC) as well as the state classes. Working on finishing the implementation of the class DC_ChargeParameterDiscovery on the EVCC side. Implementing the ScheduleExchangeReq message. Changed the implementation of the selected energy service and selected value-added services as session variables in the comm_session object. This way, we have easier access to the various service parameters, especially useful for the selected energy service. Applied ge and le restrictions to departure_time and added the missing fields ev_max_v2x_energy_request and ev_min_v2x_energy_request to the class DynamicScheduleExchangeReqParams Finished implementing state DCChargeParameterDiscovery on the EVCC side Improved/fixed the implementation of class ServiceSelection on SECC side to check if the EVCC selected the correct pairs of service ID and parameter set ID per selected service Introduced NumericID type in common_types.py and replaced simple int types for schedules IDs etc. with that type. Also changed the name of the class ListOfRootCertificateIDs to RootCertificateIDList to be consistent with the latest changes coming with PR#4 Started implememting the class ScheduleExchange on the SECC side, which includes work on the get_scheduled_se_params() and get_dynamic_se_params() functions on the EVCC and SECC side. Finished implememting the class ScheduleExchange on the SECC side Ran black on the files in this branch Ran flake8 on the files in this branch Forgot to add evcc_state.py to my last commit
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Corrected a few typos and added a sentence explaining why JRE is needed