Eric Wu / Mbed 2 deprecated WifiRobot

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

irobotCommand.h File Reference
Enumerations | Functions

irobotCommand.h File Reference

iRobot general commands. More...

Go to the source code of this file.

Enumerations

enum  irobotDemo_t {
  DEMO_COVER = 0, DEMO_COVER_DOCK = 1, DEMO_SPOT_COVER = 2, DEMO_MOUSE = 3,
  DEMO_DRIVE_FIGURE_EIGHT = 4, DEMO_WIMP = 5, DEMO_HOME = 6, DEMO_TAG = 7,
  DEMO_PACHELBEL = 8, DEMO_BANJO = 9
}
 

Demo modes.

More...

Functions

int32_t irobotBaudChange (const irobotUARTPort_t port, const irobotBaud_t baud)
 Set the iRobot baud rate.
int32_t irobotDemoStop (const irobotUARTPort_t port)
 Stop a running demo.
int32_t irobotDemo (const irobotUARTPort_t port, const irobotDemo_t demo)
 Run a demo.
int32_t irobotFull (const irobotUARTPort_t port)
 Change to FULL mode.
int32_t irobotSafe (const irobotUARTPort_t port)
 Change to SAFE mode.
int32_t irobotStart (const irobotUARTPort_t port)
 Change to START mode.

Detailed Description

iRobot general commands.

Author:
Jeff C. Jensen
Date:
2013-12-09 Copyright (C) 2013, Jeff C. Jensen, Edward A. Lee, and Sanjit A. Seshia. This software accompanies An Introductory Lab in Embedded and Cyber-Physical Systems and is licensed under a Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License. See http://leeseshia.org/lab.

Definition in file irobotCommand.h.

Enumeration Type Documentation

enum irobotDemo_t

Demo modes.

Enumerator:
DEMO_COVER 

Cover demo.

DEMO_COVER_DOCK 

Cover & dock demo.

DEMO_SPOT_COVER 

Spot cover demo.

DEMO_MOUSE 

Mouse demo.

DEMO_DRIVE_FIGURE_EIGHT 

Figure eight demo.

DEMO_WIMP 

Wimp demo.

DEMO_HOME 

Home demo.

DEMO_TAG 

Tag demo.

DEMO_PACHELBEL 

Pachelbel song demo.

DEMO_BANJO 

Banjo song demo.

Definition at line 21 of file irobotCommand.h.

Function Documentation

int32_t irobotBaudChange ( const irobotUARTPort_t  port,
const irobotBaud_t  baud 
)

Set the iRobot baud rate.

The serial port will be reconfigured to this new baud rate and restarted, which will clear communication buffers and may introduce a delay.

Warning:
baud 115200 appears to be unstable.
Returns:
error code
Parameters:
[in]portUART port
[in]baudiRobot baud code

Definition at line 4 of file irobotCommand.cpp.

int32_t irobotDemo ( const irobotUARTPort_t  port,
const irobotDemo_t  demo 
)

Run a demo.

Parameters:
[in]portUART port
[in]demodemo to run

Definition at line 39 of file irobotCommand.cpp.

int32_t irobotDemoStop ( const irobotUARTPort_t  port )

Stop a running demo.

Parameters:
[in]portUART port

Definition at line 28 of file irobotCommand.cpp.

int32_t irobotFull ( const irobotUARTPort_t  port )

Change to FULL mode.

Parameters:
[in]portUART port

Definition at line 51 of file irobotCommand.cpp.

int32_t irobotSafe ( const irobotUARTPort_t  port )

Change to SAFE mode.

Parameters:
[in]portUART port

Definition at line 61 of file irobotCommand.cpp.

int32_t irobotStart ( const irobotUARTPort_t  port )

Change to START mode.

Parameters:
[in]portUART port

Definition at line 71 of file irobotCommand.cpp.

Generated on Wed Jul 13 2022 12:36:28 by  doxygen 1.7.2