Commit 3dbf4903 authored by Maximilian Schnabel's avatar Maximilian Schnabel
Browse files

used consistent variable names

parent 78146901
......@@ -164,11 +164,11 @@ classdef EV3 < MaskedHandle
%
% Example:
% % Setup bluetooth connection via com-port 0
% b = EV3();
% b.connect('bt', 'serPort', '/dev/rfcomm0');
% brick = EV3();
% brick.connect('bt', 'serPort', '/dev/rfcomm0');
% % Setup usb connection, beep when connection has been established
% b = EV3();
% b.connect('usb', 'beep', 'on', );
% brick = EV3();
% brick.connect('usb', 'beep', 'on', );
%
% See also ISCONNECTED / :attr:`isConnected`
......@@ -234,10 +234,10 @@ classdef EV3 < MaskedHandle
% ::
%
% Example:
% b = EV3();
% b.connect('bt', 'serPort', '/dev/rfcomm0');
% brick = EV3();
% brick.connect('bt', 'serPort', '/dev/rfcomm0');
% % do stuff
% b.disconnect();
% brick.disconnect();
% Resetting needs a working connection in order to send reset-commands
% to the Brick. If the connection has been aborted (e.g. by pulling the
......@@ -283,9 +283,9 @@ classdef EV3 < MaskedHandle
% ::
%
% Example:
% b = EV3();
% b.connect('bt', 'serPort', '/dev/rfcomm0');
% b.beep();
% brick = EV3();
% brick.connect('bt', 'serPort', '/dev/rfcomm0');
% brick.beep();
%
ev3.handleCommand(@soundPlayTone, 10, 1000, 100);
end
......@@ -302,9 +302,9 @@ classdef EV3 < MaskedHandle
% ::
%
% Example:
% b = EV3();
% b.connect('bt', 'serPort', '/dev/rfcomm0');
% b.playTone(40, 5000, 1000); % Plays tone with 40% volume and 5000Hz for 1 second.
% brick = EV3();
% brick.connect('bt', 'serPort', '/dev/rfcomm0');
% brick.playTone(40, 5000, 1000); % Plays tone with 40% volume and 5000Hz for 1 second.
%
ev3.handleCommand(@soundPlayTone, volume, frequency, duration);
end
......@@ -316,10 +316,10 @@ classdef EV3 < MaskedHandle
% ::
%
% Example:
% b = EV3();
% b.connect('bt', 'serPort', '/dev/rfcomm0');
% b.playTone(10,100,100000000);
% b.stopTone(); % Stops tone immediately.
% brick = EV3();
% brick.connect('bt', 'serPort', '/dev/rfcomm0');
% brick.playTone(10,100,100000000);
% brick.stopTone(); % Stops tone immediately.
%
ev3.handleCommand(@soundStopTone);
end
......@@ -334,12 +334,12 @@ classdef EV3 < MaskedHandle
% ::
%
% Example:
% b = EV3();
% b.connect('bt', 'serPort', '/dev/rfcomm0');
% b.playTone(10, 100, 1000);
% brick = EV3();
% brick.connect('bt', 'serPort', '/dev/rfcomm0');
% brick.playTone(10, 100, 1000);
% pause(0.5);
% % Small pause necessary since tone not startong immediately
% b.tonePlayed(); % -> Outputs 1 to console.
% brick.tonePlayed(); % -> Outputs 1 to console.
%
status = ev3.handleCommand(@soundTest);
end
......@@ -395,9 +395,9 @@ classdef EV3 < MaskedHandle
% ::
%
% Example:
% b = EV3();
% b.connect('bt', 'serPort', '/dev/rfcomm0');
% b.setProperties('debug', 'on', 'batteryMode', 'Voltage');
% brick = EV3();
% brick.connect('bt', 'serPort', '/dev/rfcomm0');
% brick.setProperties('debug', 'on', 'batteryMode', 'Voltage');
% % Instead of: b.debug = 'on'; b.batteryMode = 'Voltage';
%
% See also EV3.DEBUG, EV3.BATTERYMODE / :attr:`debug`, :attr:`batteryMode`
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment