From 23444d0c033c891184826bcea2e6cdcf3dbadb26 Mon Sep 17 00:00:00 2001 From: architeuthis Date: Thu, 27 Jun 2024 10:42:18 +0800 Subject: [PATCH] doc: Mention ping() in NDSP tutorial --- doc/manual/developing_a_ndsp.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/doc/manual/developing_a_ndsp.rst b/doc/manual/developing_a_ndsp.rst index a29f02656..bc818728f 100644 --- a/doc/manual/developing_a_ndsp.rst +++ b/doc/manual/developing_a_ndsp.rst @@ -129,6 +129,13 @@ Now it can be added using ``self.setattr_device("hello")`` in the ``build()`` ph self.hello.message("Hello world!") +.. note:: + In order to be correctly started and stopped by a controller manager, your controller must additionally implement a ``ping()`` method, which should simply return true, e.g. :: + + def ping(self): + return True + + Remote execution support ------------------------