Unclear documentation in is_contactor_opened

[raoulKalkman]

This is about the functions in iso15118/secc/controller/interface.py

The functions are written as if they are checks for the contactor, however the documentation is unclear.

Especially the is_contactor_opened confuses me while making an implementation.

I would suggest either changing the function name in case it actually opens the contactor (this would surprise me) or writing a doc as something like "Check if the contactor is opened. (open contactor -> terminated energy flow)"

That of course is a draft, but I hope you get the gist of it.

    @abstractmethod
    async def is_contactor_opened(self) -> bool:
        """
        Sends a command to the SECC to get the contactor status is opened to terminate
        energy flow

        Relevant for:
        - all protocols
        """
        raise NotImplementedError

    @abstractmethod
    async def is_contactor_closed(self) -> Optional[bool]:
        """
        Sends a command to the SECC to get the contactor status is closed

        Relevant for:
        - all protocols
        """
        raise NotImplementedError

[shalinnijel2]

Hi @raoulKalkman, Yes, the comment is misleading. Thank you for pointing this out. Have updated it in master now. PR. Kind regards, Shalin.