diff --git a/pphelper/hardware.py b/pphelper/hardware.py index 203d00c..304600d 100644 --- a/pphelper/hardware.py +++ b/pphelper/hardware.py @@ -1184,29 +1184,32 @@ def _send(self, message): pass @property - def config_file(self): + def test_mode(self): """ - The absolute path to the configuration file. + :type: :obj:`bool` - :getter: Return the currently set configuration file path. - :setter: Set the configuration file path. Must be an absolute path. - :type: string + :obj:`True` if we're in test mode, :obj:`False` otherwise. + + Notes + ----- + This property can only be set on class instantiation by passing + the ``test_mode`` keyword argument. """ - return self._config_file + return self._test_mode - @config_file.setter - def config_file(self, path): + @property + def config_file(self): """ - Set the path to the configuration file. An absolute path is required. + :type: string - Parameters - ---------- - path : string - The path to the configuration file, e.g., - 'C:\\Users\EEG\\Desktop\\Experiment\\config.xml'. + The absolute path to the configuration file. """ + return self._config_file + + @config_file.setter + def config_file(self, path): msg = '1%s' % path self._send(msg) time.sleep(1.2) @@ -1310,8 +1313,11 @@ def recording(self): :type: bool `True` if we're currently recording data, and `False` otherwise. - This property cannot be set directly. Use ``start_recording()`` and - `stop_recording` instead. + + Notes + ----- + This property cannot be set directly. Use + :func:`~start_recording` and :func:`~stop_recording` instead. """ return self._recording