Renesas / Mbed OS mbed-os_Watson-IoT_ZXing_sample

Sample program showing how to connect GR-PEACH into Watson IoT through mbed Connector and Watson's Connector Bridge

Dependencies:   AsciiFont DisplayApp GR-PEACH_video LCD_shield_config LWIPBP3595Interface_STA_for_mbed-os USBDevice

Embed: (wiki syntax)

« Back to documentation index

LEDResource Class Reference
Public Member Functions

LEDResource Class Reference

LEDResource class. More...

#include <LEDResource.h>

Inherits DynamicResource.

Public Member Functions

 LEDResource (const Logger *logger, const char *obj_name, const char *res_name, const bool observable=false)
 Default constructor.
virtual void put (const string value)
 Set the value of the LED.
virtual void bind (void *ep)
 Bind resource to endpoint.
uint8_t process (M2MBase::Operation op, M2MBase::BaseType type, void *args=NULL)
 Process the CoAP message.
virtual string get ()
 Resource value getter (REQUIRED: must be implemented in derived class as all Binders MUST support and implement GET)
virtual void post (void *args)
 Resource value setter (POST) (OPTIONAL: defaulted noop if not derived.
virtual void del (void *args)
 Resource value deleter (OPTIONAL: defaulted noop if not derived.
int notify (const string data)
 Send notification of new data.
bool isObservable ()
 Determine whether this dynamic resource is observable or not.
void setObserver (void *observer)
 Set the observer pointer.
void setContentFormat (uint8_t content_format)
 Set the content format for responses.
void setMaxAge (uint8_t maxage)
 Set the max-age for cache control of responses in a proxy cache.
void setDataWrapper (DataWrapper *data_wrapper)
 Set the data wrapper.
virtual void observe ()
 observe the resource
M2MResource * getResource ()
 get the base resource representation
void process_resource_post (void *args)
 Process a POST message for Resources.
bool isConnected ()
 Determine if we are connected or not.
bool isRegistered ()
 Determine if we are registered or not.
void * getObserver ()
 Get our Observer.
string getObjName ()
 Get the Object name.
string getResName ()
 Get the Resource name.
string getFullName ()
 Get the Full name.
string getValue ()
 Get the resource value.
void setName (const string name)
 Set the resource name.
void setValue (const stringvalue)
 Set the resource value.
void setOptions (const void *options)
 set the options
void setEndpoint (const void *endpoint)
 set the endpoint
int getInstanceNumber ()
 Get our Instance Number.
void setInstanceNumber (int instance_number)
 Set our Instance Number.

Detailed Description

LEDResource class.

Definition at line 38 of file LEDResource.h.

Constructor & Destructor Documentation

LEDResource ( const Logger *  logger,
const char *  obj_name,
const char *  res_name,
const bool  observable = false 
)

Default constructor.

Parameters:
loggerinput logger instance for this resource
obj_nameinput the LED Object name
res_nameinput the LED Resource name
observableinput the resource is Observable (default: FALSE)

Definition at line 49 of file LEDResource.h.

Member Function Documentation

void bind ( void *  ep ) [virtual, inherited]

Bind resource to endpoint.

Parameters:
epinput endpoint instance pointer

Implements Resource< string >.

Definition at line 114 of file DynamicResource.cpp.

void del ( void *  args ) [virtual, inherited]

Resource value deleter (OPTIONAL: defaulted noop if not derived.

Binders MAY implement DELETE if needed)

Parameters:
void* args for the del() operation

Definition at line 337 of file DynamicResource.cpp.

string get (  ) [virtual, inherited]

Resource value getter (REQUIRED: must be implemented in derived class as all Binders MUST support and implement GET)

Returns:
string value of the resource

Reimplemented in ZXingResource.

Definition at line 315 of file DynamicResource.cpp.

string getFullName (  ) [inherited]

Get the Full name.

Returns:
the name of the object

Definition at line 113 of file Resource.h.

int getInstanceNumber (  ) [inherited]

Get our Instance Number.

Returns:
our instance number

Definition at line 176 of file Resource.h.

string getObjName (  ) [inherited]

Get the Object name.

Returns:
the name of the object

Definition at line 97 of file Resource.h.

void * getObserver (  ) [inherited]

Get our Observer.

Definition at line 482 of file DynamicResource.cpp.

string getResName (  ) [inherited]

Get the Resource name.

Returns:
the name of the resource

Definition at line 105 of file Resource.h.

M2MResource * getResource (  ) [inherited]

get the base resource representation

Definition at line 164 of file DynamicResource.cpp.

string getValue (  ) [inherited]

Get the resource value.

Returns:
the value of the resource

Definition at line 124 of file Resource.h.

bool isConnected (  ) [inherited]

Determine if we are connected or not.

Definition at line 434 of file DynamicResource.cpp.

bool isObservable (  ) [inherited]

Determine whether this dynamic resource is observable or not.

Returns:
true - is observable, false - otherwise

Definition at line 133 of file DynamicResource.h.

bool isRegistered (  ) [inherited]

Determine if we are registered or not.

Definition at line 457 of file DynamicResource.cpp.

int notify ( const string  data ) [inherited]

Send notification of new data.

Parameters:
datainput the new data to update
Returns:
1 - success, 0 - failure

Definition at line 276 of file DynamicResource.cpp.

void observe (  ) [virtual, inherited]

observe the resource

Definition at line 344 of file DynamicResource.cpp.

void post ( void *  args ) [virtual, inherited]

Resource value setter (POST) (OPTIONAL: defaulted noop if not derived.

Binders MAY implement POST if needed)

Parameters:
void* args for the post() operation

Reimplemented in DeviceDeRegisterResource.

Definition at line 330 of file DynamicResource.cpp.

uint8_t process ( M2MBase::Operation  op,
M2MBase::BaseType  type,
void *  args = NULL 
) [inherited]

Process the CoAP message.

Parameters:
opinput the CoAP Verb (operation)
typeinput clarification of the M2MBase instance being passed in (Object vs. ObjectInstance vs. Resource vs. ResourceInstance)
argsinput arguments (unused)
Returns:
0 - success, 1 - failure

Definition at line 176 of file DynamicResource.cpp.

void process_resource_post ( void *  args ) [inherited]

Process a POST message for Resources.

Definition at line 169 of file DynamicResource.cpp.

virtual void put ( const string  value ) [virtual]

Set the value of the LED.

Parameters:
stringinput the string containing "0" (light off) or "1" (light on)

Reimplemented from DynamicResource.

Definition at line 56 of file LEDResource.h.

void setContentFormat ( uint8_t  content_format ) [inherited]

Set the content format for responses.

Parameters:
content_formatshort integer CoAP content-format ID

Definition at line 356 of file DynamicResource.cpp.

void setDataWrapper ( DataWrapper *  data_wrapper ) [inherited]

Set the data wrapper.

Parameters:
data_wrapperinput the data wrapper instance

Definition at line 157 of file DynamicResource.h.

void setEndpoint ( const void *  endpoint ) [inherited]

set the endpoint

Definition at line 165 of file Resource.h.

void setInstanceNumber ( int  instance_number ) [inherited]

Set our Instance Number.

Parameters:
instance_numberinput our designated instance number

Definition at line 182 of file Resource.h.

void setMaxAge ( uint8_t  maxage ) [inherited]

Set the max-age for cache control of responses in a proxy cache.

Parameters:
maxageshort integer CoAP max-age in seconds

Definition at line 361 of file DynamicResource.cpp.

void setName ( const string  name ) [inherited]

Set the resource name.

Parameters:
nameinput the resource name

Definition at line 132 of file Resource.h.

void setObserver ( void *  observer ) [inherited]

Set the observer pointer.

Parameters:
observerinput the pointer to the ResourceObserver observing this resource

Definition at line 351 of file DynamicResource.cpp.

void setOptions ( const void *  options ) [inherited]

set the options

Definition at line 158 of file Resource.h.

void setValue ( const string  value ) [inherited]

Set the resource value.

Parameters:
valueinput the resource value

Definition at line 140 of file Resource.h.

Generated on Thu Jul 14 2022 21:25:55 by  doxygen 1.7.2