Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[refine] Design UDS Client API #5

Open
mdabrowski1990 opened this issue Feb 9, 2021 · 0 comments
Open

[refine] Design UDS Client API #5

mdabrowski1990 opened this issue Feb 9, 2021 · 0 comments
Labels
implementation Changes to code

Comments

@mdabrowski1990
Copy link
Owner

mdabrowski1990 commented Feb 9, 2021

Requires

#48

Description

As a user, I would like to have Client's API defined, so I know how to execute certain actions using this package.
As a developer, I would like to have UDS Client class with methods (with annotations and descriptions) defined, so I know what has to be implemented and what functionalities would be provided by client simulation.

Acceptance criteria

  • Client class is defined.
  • Each Client's method has annotations and description. There shall be no code, preferable it raises exception.
  • Client's methods are defined to provide following functionalities:
    • Setting and reading Client configuration (client parameters e.g. p2_client) - more details in [refine] Client - configuration #72
    • Sending diagnostic request and receiving all response(s) to this request (only the first one if cyclical/on event responses are expected).
    • Starting cyclical sending of TesterPresent frames.
    • Stopping cyclical sending of TesterPresent frames.
    • Getting multiple responses that are transmitted periodically or on event (e.g. SID 0x2A or 0x86).
@mdabrowski1990 mdabrowski1990 added the implementation Changes to code label Feb 9, 2021
@mdabrowski1990 mdabrowski1990 added this to the First release milestone Feb 9, 2021
@mdabrowski1990 mdabrowski1990 changed the title UDS Client Introduce UDS Client Feb 9, 2021
@mdabrowski1990 mdabrowski1990 changed the title Introduce UDS Client [Base] Introduce UDS Client Feb 9, 2021
@mdabrowski1990 mdabrowski1990 changed the title [Base] Introduce UDS Client Introduce UDS Client Feb 9, 2021
@mdabrowski1990 mdabrowski1990 self-assigned this Feb 10, 2021
@mdabrowski1990 mdabrowski1990 removed their assignment Aug 13, 2021
@mdabrowski1990 mdabrowski1990 modified the milestones: First release - basic functionality, Client Simulation Aug 15, 2021
@mdabrowski1990 mdabrowski1990 changed the title Introduce UDS Client Design UDS Client Aug 20, 2021
@mdabrowski1990 mdabrowski1990 modified the milestones: X) Client Simulation, 2) Basic client support for CAN Sep 6, 2021
@mdabrowski1990 mdabrowski1990 changed the title Design UDS Client Design UDS Client API Sep 7, 2021
@mdabrowski1990 mdabrowski1990 changed the title Design UDS Client API [refine] Design UDS Client API Nov 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
implementation Changes to code
Projects
None yet
Development

No branches or pull requests

1 participant