MCP41_Simple
Arduino Library for the MCP41 Series Of 8 Bit Digital Potentiometers
MCP41_Simple Class Reference

Copyright (C) 2017 James Sleeman. More...

#include <MCP41_Simple.h>

Public Member Functions

 MCP41_Simple ()
 Copyright (C) 2017 James Sleeman. More...
 
 MCP41_Simple (SPIClass &spiBus)
 Initialise potentiometer on a specified SPI bus. More...
 
void begin (uint8_t chipSelectPin)
 Begin communication to the potentiometer using the supplied pin as it's chipSelect.
 
void setWiper (uint8_t value)
 Set the wiper position of the potentiometer, to a position between 0 and 255.
 
void shutdownMode ()
 Put the potentiometer in shutdown mode, output B gets tied to the Wiper, and output A is tri-stated.
 

Protected Attributes

uint8_t _chipSelectPin
 
SPIClass * _spiBus
 

Detailed Description

Copyright (C) 2017 James Sleeman.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author
James Sleeman, http://sparks.gogo.co.nz/ MIT License

Constructor & Destructor Documentation

MCP41_Simple::MCP41_Simple ( )

Copyright (C) 2017 James Sleeman.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author
James Sleeman, http://sparks.gogo.co.nz/ MIT License
See also
http://ww1.microchip.com/downloads/en/DeviceDoc/11195c.pdfInitialise potentiometer on the default SPI bus.
MCP41_Simple::MCP41_Simple ( SPIClass &  spiBus)

Initialise potentiometer on a specified SPI bus.

If you have more than one SPI bus available, you can pass an appropriate SPIClass object here.

Example:

MCP41_Simple MyPot(SPI1);

This is untested, but should work, assuming your alternative SPI bus also inherits from SPIClass like the default SPI bus does.


The documentation for this class was generated from the following files: