From 9944cf3adf459e959acf0a450dcbba09b19caab0 Mon Sep 17 00:00:00 2001 From: Laurens Valk Date: Wed, 7 Jul 2021 17:07:14 +0200 Subject: [PATCH] pybricks.common.System: Add name() getter. --- doc/api/hubs/cityhub.rst | 2 ++ doc/api/hubs/movehub.rst | 2 ++ doc/api/hubs/primehub.rst | 2 ++ doc/api/hubs/technichub.rst | 2 ++ src/pybricks/_common.py | 9 +++++++++ 5 files changed, 17 insertions(+) diff --git a/doc/api/hubs/cityhub.rst b/doc/api/hubs/cityhub.rst index a870465..e8e63c0 100644 --- a/doc/api/hubs/cityhub.rst +++ b/doc/api/hubs/cityhub.rst @@ -29,6 +29,8 @@ City Hub .. automethod:: pybricks.hubs::CityHub.system.set_stop_button + .. automethod:: pybricks.hubs::CityHub.system.name + .. automethod:: pybricks.hubs::CityHub.system.shutdown .. automethod:: pybricks.hubs::CityHub.system.reset_reason diff --git a/doc/api/hubs/movehub.rst b/doc/api/hubs/movehub.rst index 1e9b578..37012f2 100644 --- a/doc/api/hubs/movehub.rst +++ b/doc/api/hubs/movehub.rst @@ -37,6 +37,8 @@ Move Hub .. automethod:: pybricks.hubs::MoveHub.system.set_stop_button + .. automethod:: pybricks.hubs::MoveHub.system.name + .. automethod:: pybricks.hubs::MoveHub.system.shutdown .. automethod:: pybricks.hubs::MoveHub.system.reset_reason diff --git a/doc/api/hubs/primehub.rst b/doc/api/hubs/primehub.rst index 5478fd2..1a5a3d1 100644 --- a/doc/api/hubs/primehub.rst +++ b/doc/api/hubs/primehub.rst @@ -85,6 +85,8 @@ Prime Hub / Inventor Hub .. automethod:: pybricks.hubs::PrimeHub.system.set_stop_button + .. automethod:: pybricks.hubs::PrimeHub.system.name + .. automethod:: pybricks.hubs::PrimeHub.system.shutdown .. automethod:: pybricks.hubs::PrimeHub.system.reset_reason diff --git a/doc/api/hubs/technichub.rst b/doc/api/hubs/technichub.rst index ad026a9..8037a60 100644 --- a/doc/api/hubs/technichub.rst +++ b/doc/api/hubs/technichub.rst @@ -43,6 +43,8 @@ Technic Hub .. automethod:: pybricks.hubs::TechnicHub.system.set_stop_button + .. automethod:: pybricks.hubs::TechnicHub.system.name + .. automethod:: pybricks.hubs::TechnicHub.system.shutdown .. automethod:: pybricks.hubs::TechnicHub.system.reset_reason diff --git a/src/pybricks/_common.py b/src/pybricks/_common.py index 9449f40..16a673e 100644 --- a/src/pybricks/_common.py +++ b/src/pybricks/_common.py @@ -42,6 +42,15 @@ class System: """ pass + def name(self): + """Gets the hub name. This is the name you see when connecting + via Bluetooth. + + Returns: + str: The hub name. + """ + pass + class DCMotor: """Generic class to control simple motors without rotation sensors, such