uds icon indicating copy to clipboard operation
uds copied to clipboard

[refine] Design UDS Client API

Open mdabrowski1990 opened this issue 4 years ago • 0 comments

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 #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 avatar Feb 09 '21 10:02 mdabrowski1990

#16 must be completed prior (or together) with this one.

mdabrowski1990 avatar Feb 09 '21 12:02 mdabrowski1990