Prop.md

Prop class reference

See also:

• PropData class reference

Props unified coding

Each flavor of PyProp base class either implements or redefines the Prop base class interface:

• AsyncioProp see PropApp.py
• PygameProp see PropApp.py
• QtProp see QtPropApp.h
• GuizeroProp see PropApp.py
• KivyProp see KivyProp.h

Constructor

Every Prop constructor expects:

• client parameter
  • a Paho MQTT client created in main.py usually with mqtt_client = mqtt.Client(uuid.uuid4().urn, clean_session=True, userdata=None)

Regarding the Prop flavor you will have to provide more parameters, such as argv and others.

See:

• AsyncioProp main.py example
• PygameProp main.py example
• QtProp main.py example
• GuizeroProp main.py example
• KivyProp main.py example

Interface

The Prop class interface is consistent with the Prop class of the ArduinoProps library for Arduino boards.

• addData(data)
  • registers a PropData instance to be treated by sendAllData() and sendDataChanges() methods
• addPeriodicAction(title, func, time)
  • add an action func to be executed every time period (in seconds)
• sendAllData()
  • sends the DATA message for all registered data
• sendDataChanges()
  • sends the DATA message for all registered data that value has changed since last call.
• sendData(data)
  • send the data string in a DATA message
• sendDone(action)
  • send the action string in a DONE message
• sendMesg(message, topic=None)
  • send the message string in a MESG message to the outbox or the topic parameter
• sendOmit(action)
  • send the action string in a OMIT message
• sendOver(challenge)
  • send the challenge string in a OVER message
• sendProg(program)
  • send the program string in a PROG message
• sendRequ(request, topic=None)
  • send the request string in a REQU message to the outbox or the topic parameter

For send----() methods see Room Outbox protocol

Author

Faure Systems (Apr 17th, 2020)

• company: FAURE SYSTEMS SAS
• mail: dev at faure dot systems
• github: fauresystems
• web: Faure Systems