Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision
Previous revision
en:iot-open:remotelab:itt:controlmodule [2018/12/06 06:08] rim.puksen:iot-open:remotelab:itt:controlmodule [2020/07/20 09:00] (current) – external edit 127.0.0.1
Line 1: Line 1:
-===== Controller module basics=====+===== ITT Controller module basics =====
  
  
 ==== Introduction  ==== ==== Introduction  ====
-This chapter describes the IOT ITT controller module. Controller module is necessary for for any other module to work. +This chapter describes the IOT ITT controller module. The controller module is necessary for any other module to work. 
  
 {{:en:iot_homelab_kit:hardware:controller.png?200|}} {{:en:iot_homelab_kit:hardware:controller.png?200|}}
Line 17: Line 17:
 {{:en:iot_homelab_kit:hardware:d1mini_pinout.png?300|}} {{:en:iot_homelab_kit:hardware:d1mini_pinout.png?300|}}
  
-===== Specifications=====+==== Specifications====
   * 11 digital input/output pins   * 11 digital input/output pins
   * Micro USB connector   * Micro USB connector
Line 24: Line 24:
   * 4 MB flash-memory   * 4 MB flash-memory
  
-===== Electrical connection =====+==== Electrical connection ====
 Modules are using following I/O ports Modules are using following I/O ports
  
Line 34: Line 34:
   *     Sensor Shield (ITT ver. 1.1) GPIO4, GPIO5, GPIO6, GPIO7, A0   *     Sensor Shield (ITT ver. 1.1) GPIO4, GPIO5, GPIO6, GPIO7, A0
  
-=== Actuators ===+==== Actuators ====
 As this is the controller module, no actuators or sensors are installed to it. As this is the controller module, no actuators or sensors are installed to it.
  
-=== Software, libraries and externals === +==== Software, libraries and externals ==== 
-To program the controller module ITTIoT libary is used. This is a custom libary made specifically for ITT IoT kits. It aims to make the board easier to use with simple but yet effective methods.+To program the controller module ITTIoT library is used. This is a custom library made specifically for ITT IoT kits. It aims to make the board easier to use with simple but yet effective methods. A non-exclusive list of methods is presented below:
  
-<table Ref.Tab.1.1> 
-<caption>List of ITTIoT methods</caption> 
 ^ Method ^ Description ^ ^ Method ^ Description ^
 | iot.setup() | Does the operations necessary for setting up the ITTIoT framework and MQTT communications.| | iot.setup() | Does the operations necessary for setting up the ITTIoT framework and MQTT communications.|
 | iot.printConfig() | Prints the module configuration to the serial port.| | iot.printConfig() | Prints the module configuration to the serial port.|
-| iot.handle() | Does the background work necessary for the communications to work. For example checks if the communication with the broker is still working and checks if any new messages have been received. This method has to be called periodically.| +| iot.handle() | Does the background work necessary for the communications to work. For examplechecks if the communication with the broker is still working and checks if any new messages have been received. This method has to be called periodically.| 
-| iot.connected() | A method defined by the user that is called when the connection with the MQTT broker has been established. It is primarly used to subscribe into topics with the method iot.subscribe().|+| iot.connected() | A method defined by the user that is called when the connection with the MQTT broker has been established. It is primarily used to subscribe to topics with the method iot.subscribe().|
 | iot.subscribe(String topic) | Subscribes to the topic specified as the operand. For example iot.subscribe("IoT/button") subscribes to the topic "IoT/button".| | iot.subscribe(String topic) | Subscribes to the topic specified as the operand. For example iot.subscribe("IoT/button") subscribes to the topic "IoT/button".|
-| iot.received(String topic, String msg) | User defined method that is called when the controller receives a message from one the subscribed topics. The topic from which the message is received is the string "topic" and the body of the message is the string "msg".|+| iot.received(String topic, String msg) | User-defined method that is called when the controller receives a message from one of the subscribed topics. The topic from which the message is received is the string "topic" and the body of the message is the string "msg".|
 | iot.publishMsgTo(String topic, String msg, bool retain) | Publishes the message "msg" to the topic "topic". Boolean retain informs the broker if the message should be saved into the memory of the broker.| | iot.publishMsgTo(String topic, String msg, bool retain) | Publishes the message "msg" to the topic "topic". Boolean retain informs the broker if the message should be saved into the memory of the broker.|
-</table> 
  
-=== Communication ===+ 
 +==== Communication ====
 The user can connect to and program this controller using the Distancelab environment. The user can connect to and program this controller using the Distancelab environment.
  
-=== Limits === +==== Limits ==== 
-At the same time one user can program the controller. But all users connected to the Distancelab MQTT broker can subscribe to and publish messages to the topics.+At the same timeone user can program the controller. But all users connected to the Distancelab MQTT broker can subscribe to and publish messages to the topics.
  
en/iot-open/remotelab/itt/controlmodule.1544076520.txt.gz · Last modified: 2020/07/20 09:00 (external edit)
CC Attribution-Share Alike 4.0 International
www.chimeric.de Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0