Doxygen update
git-svn-id: https://svn.vbchaos.nl/svn/hsb/trunk@428 05563f52-14a8-4384-a975-3d1654cca0fa
This commit is contained in:
@@ -138,6 +138,7 @@ struct NHD0420
|
||||
* NHD0420_construct
|
||||
* Initialises the NewHeaven Display 0420
|
||||
*
|
||||
* @memberof NHD0420
|
||||
* @param interface The interface to use
|
||||
*
|
||||
* @return ErrorStatus SUCCESS if initialisation was successful
|
||||
@@ -153,6 +154,7 @@ extern ErrorStatus NHD0420_construct(struct NHD0420* self, const struct IODevice
|
||||
* NHD0420_destruct
|
||||
* Destructor for the NHD0420 instance
|
||||
*
|
||||
* @memberof NHD0420
|
||||
* @param interface The object to destruct
|
||||
*
|
||||
* @return void
|
||||
@@ -181,6 +183,7 @@ extern ErrorStatus NHD0420_getSpiParameters(struct SpiParameters* parameters);
|
||||
* NHD0420_setCursorToPosition
|
||||
* Sets the cursor of the display to the specified row and column
|
||||
*
|
||||
* @memberof NHD0420
|
||||
* @param row The Row to set - between 1 and 4
|
||||
* @param column The column to set - between 1 and 20
|
||||
*
|
||||
@@ -197,6 +200,7 @@ extern ErrorStatus NHD0420_setCursorToPosition(const struct NHD0420* self, unsig
|
||||
* NHD0420_setContrast
|
||||
* Sets the contrast of the display
|
||||
*
|
||||
* @memberof NHD0420
|
||||
* @param contrast The contrast to set - between 1 and 50.
|
||||
* If passed value is outside the boundaries
|
||||
* this function will return ERROR
|
||||
@@ -214,6 +218,7 @@ extern ErrorStatus NHD0420_setContrast(const struct NHD0420* self, char contrast
|
||||
* NHD0420_setBacklightBrightness
|
||||
* Sets the backlight brightness of the display
|
||||
*
|
||||
* @memberof NHD0420
|
||||
* @param brightness The contrast to set - between 1 and 8
|
||||
* If passed value is outside the boundaries
|
||||
* this function will return ERROR
|
||||
@@ -231,6 +236,7 @@ extern ErrorStatus NHD0420_setBacklightBrightness(const struct NHD0420* self, ch
|
||||
* NHD0420_setRS232Baudrate
|
||||
* Sets the baudrate of the display
|
||||
*
|
||||
* @memberof NHD0420
|
||||
* @param baudrate The baudrate to set - between 1 and 8
|
||||
* 1 = 300 baud
|
||||
* 2 = 1200 baud
|
||||
@@ -256,6 +262,7 @@ extern ErrorStatus NHD0420_setRS232Baudrate(const struct NHD0420* self, char bau
|
||||
* NHD0420_setI2CAddress
|
||||
* Sets the I2C address of the display
|
||||
*
|
||||
* @memberof NHD0420
|
||||
* @param address The address to set
|
||||
* This command sets the I2C address. The
|
||||
* address must be an even number (LSB = 0)
|
||||
@@ -281,6 +288,7 @@ extern ErrorStatus NHD0420_setI2CAddress(const struct NHD0420* self, char addres
|
||||
* NHD0420_SendCommand
|
||||
* Send a command to the display
|
||||
*
|
||||
* @memberof NHD0420
|
||||
* @param command
|
||||
*
|
||||
* @return ErrorStatus SUCCESS if initialisation was successful
|
||||
@@ -291,6 +299,17 @@ extern ErrorStatus NHD0420_setI2CAddress(const struct NHD0420* self, char addres
|
||||
*/
|
||||
extern ErrorStatus NHD0420_sendCommand(const struct NHD0420* self, char command);
|
||||
|
||||
/** ----------------------------------------------------------------------------
|
||||
* NHD0420_sendData
|
||||
*
|
||||
* @memberof NHD0420
|
||||
*
|
||||
* @return ErrorStatus SUCCESS if initialisation was successful
|
||||
* ERROR otherwise
|
||||
*
|
||||
* @todo
|
||||
* -----------------------------------------------------------------------------
|
||||
*/
|
||||
extern ErrorStatus NHD0420_sendData(const struct NHD0420* self, const char* buffer, unsigned int length);
|
||||
|
||||
#endif /* DISPLAY_INC_NHD0420_H_ */
|
||||
|
||||
Reference in New Issue
Block a user