Fork of the official mbed C/C++ SDK provides the software platform and libraries to build your applications. The fork has the documentation converted to Doxygen format
Dependents: NervousPuppySprintOne NervousPuppySprint2602 Robot WarehouseBot1 ... more
Fork of mbed by
AnalogIn Class Reference
An analog input, used for reading the voltage on a pin. More...
#include <AnalogIn.h>
Inherits mbed::Base.
Public Member Functions | |
AnalogIn (PinName pin, const char *name=NULL) | |
Create an AnalogIn, connected to the specified pin. | |
float | read () |
Read the input voltage, represented as a float in the range [0.0, 1.0]. | |
unsigned short | read_u16 () |
Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF]. | |
operator float () | |
An operator shorthand for read() | |
virtual struct rpc_method * | get_rpc_methods () |
Returns a pointer to an array describing the rpc methods supported by this object, terminated by either RPC_METHOD_END or RPC_METHOD_SUPER(Superclass). | |
void | register_object (const char *name) |
Registers this object with the given name, so that it can be looked up with lookup. | |
const char * | name () |
Returns the name of the object. | |
virtual bool | rpc (const char *method, const char *arguments, char *result) |
Call the given method with the given arguments, and write the result into the string pointed to by result. | |
Static Public Member Functions | |
static bool | rpc (const char *name, const char *method, const char *arguments, char *result) |
Use the lookup function to lookup an object and, if successful, call its rpc method. | |
static Base * | lookup (const char *name, unsigned int len) |
Lookup and return the object that has the given name. | |
template<class C > | |
static void | add_rpc_class () |
Add the class to the list of classes which can have static methods called via rpc (the static methods which can be called are defined by that class' get_rpc_class() static method). |
Detailed Description
An analog input, used for reading the voltage on a pin.
Example:
// Print messages when the AnalogIn is greater than 50% #include "mbed.h" AnalogIn temperature(p20); int main() { while(1) { if(temperature > 0.5) { printf("Too hot! (%f)", temperature.read()); } } }
Definition at line 38 of file AnalogIn.h.
Constructor & Destructor Documentation
AnalogIn | ( | PinName | pin, |
const char * | name = NULL |
||
) |
Member Function Documentation
static void add_rpc_class | ( | ) | [static, inherited] |
virtual struct rpc_method* get_rpc_methods | ( | ) | [read, virtual] |
Returns a pointer to an array describing the rpc methods supported by this object, terminated by either RPC_METHOD_END or RPC_METHOD_SUPER(Superclass).
Example
class Example : public Base { int foo(int a, int b) { return a + b; } virtual const struct rpc_method *get_rpc_methods() { static const rpc_method rpc_methods[] = { { "foo", generic_caller<int, Example, int, int, &Example::foo> }, RPC_METHOD_SUPER(Base) }; return rpc_methods; } };
Reimplemented from Base.
static Base* lookup | ( | const char * | name, |
unsigned int | len | ||
) | [static, inherited] |
Lookup and return the object that has the given name.
- Parameters:
-
name the name to lookup. len the length of name.
const char* name | ( | ) | [inherited] |
Returns the name of the object.
- Returns:
- The name of the object, or NULL if it has no name.
operator float | ( | ) |
float read | ( | ) |
Read the input voltage, represented as a float in the range [0.0, 1.0].
- Returns:
- A floating-point value representing the current input voltage, measured as a percentage
unsigned short read_u16 | ( | ) |
Read the input voltage, represented as an unsigned short in the range [0x0, 0xFFFF].
- Returns:
- 16-bit unsigned short representing the current input voltage, normalised to a 16-bit value
void register_object | ( | const char * | name ) | [inherited] |
Registers this object with the given name, so that it can be looked up with lookup.
If this object has already been registered, then this just changes the name.
- Parameters:
-
name The name to give the object. If NULL we do nothing.
static bool rpc | ( | const char * | name, |
const char * | method, | ||
const char * | arguments, | ||
char * | result | ||
) | [static, inherited] |
Use the lookup function to lookup an object and, if successful, call its rpc method.
- Returns:
- false if name does not correspond to an object, otherwise the return value of the call to the object's rpc method.
virtual bool rpc | ( | const char * | method, |
const char * | arguments, | ||
char * | result | ||
) | [virtual, inherited] |
Call the given method with the given arguments, and write the result into the string pointed to by result.
The default implementation calls rpc_methods to determine the supported methods.
- Parameters:
-
method The name of the method to call. arguments A list of arguments separated by spaces. result A pointer to a string to write the result into. May be NULL, in which case nothing is written.
- Returns:
- true if method corresponds to a valid rpc method, or false otherwise.
Generated on Tue Jul 12 2022 11:27:30 by 1.7.2