Jan Visser / DMSupport

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:   DM_FATFileSystem DM_HttpServer DM_USBHost EthernetInterface USBDevice mbed-rpc mbed-rtos

Fork of DMSupport by Embedded Artists

Embed: (wiki syntax)

« Back to documentation index

DMBoard Class Reference
Public Member Functions | Static Public Member Functions

DMBoard Class Reference

Example of using the Board class: More...

#include <DMBoard.h>

Public Member Functions

BoardError init ()
 Initializes the wanted features.
void setLED (Leds led, bool on)
 Controls the four LEDs on the Display Module.
void buzzer (int frequency=0, int duration_ms=0)
 Controls the buzzer.
bool buttonPressed ()
 Test if the USER button is pressed or not.
TouchPanel * touchPanel ()
 Returns the TouchPanel interface.
Display * display ()
 Returns the Display interface.
RtosLog * logger ()
 Returns the logger interface.
Registry * registry ()
 Returns the Registry interface.
MCIFileSystem * getMciFS ()
 Returns the MCI File System instance.
QSPIFileSystem * getQspiFS ()
 Returns the QSPI File System instance.

Static Public Member Functions

static DMBoard & instance ()
 Get the only instance of the DMBoard.

Detailed Description

Example of using the Board class: 

 #include "mbed.h"
 #include "DMBoard.h"

 int main(void) {
    DMBoard* board = &DMBoard::instance();
    board->init();
    ...
    board->setLed(1, true);
 }

Definition at line 55 of file DMBoard.h.

Member Function Documentation

bool buttonPressed (  )

Test if the USER button is pressed or not.

Returns:
True if the button is pressed, false if not

Definition at line 197 of file DMBoard.cpp.

void buzzer ( int  frequency = 0,
int  duration_ms = 0 
)

Controls the buzzer.

Examples: buzzer() turns it off buzzer(440) plays an A4 (440Hz) note forever buzzer(200, 25) plays a 200Hz tone for 25ms and then turns it off

Note that if duration_ms is >0 this is a blocking call

Parameters:
frequencythe frequency of the tone (in Hz) or 0 to turn it off
duration_msthe number of milliseconds to play or 0 for forever

Definition at line 183 of file DMBoard.cpp.

Display * display (  )

Returns the Display interface.

Returns:
The display

Definition at line 212 of file DMBoard.cpp.

MCIFileSystem* getMciFS (  )

Returns the MCI File System instance.

Can be used to call e.g. cardInserted().

Returns:
The file system instance

Definition at line 160 of file DMBoard.h.

QSPIFileSystem* getQspiFS (  )

Returns the QSPI File System instance.

Can be used to call e.g. isformatted() and format().

Returns:
The file system instance

Definition at line 172 of file DMBoard.h.

DMBoard::BoardError init (  )

Initializes the wanted features.

Returns:
Ok on success An error code on failure

Definition at line 99 of file DMBoard.cpp.

static DMBoard& instance (  ) [static]

Get the only instance of the DMBoard.

Returns:
The DMBoard

Definition at line 80 of file DMBoard.h.

RtosLog* logger (  )

Returns the logger interface.

Returns:
The logger

Definition at line 141 of file DMBoard.h.

Registry* registry (  )

Returns the Registry interface.

Returns:
The registry

Definition at line 149 of file DMBoard.h.

void setLED ( Leds  led,
bool  on 
)

Controls the four LEDs on the Display Module.

Parameters:
ledOne of Led1, Led2, Led3 or Led4
ontrue to turn the LED on regardless of its polarity

Definition at line 165 of file DMBoard.cpp.

TouchPanel * touchPanel (  )

Returns the TouchPanel interface.

Returns:
The touch panel

Definition at line 202 of file DMBoard.cpp.

Generated on Tue Jul 12 2022 21:29:02 by  doxygen 1.7.2