From 194be212e96b830b62545bb42ab55730cfb5fdf6 Mon Sep 17 00:00:00 2001 From: Pragya28 Date: Wed, 6 Jun 2018 23:16:39 +0530 Subject: Images in documentation --- .../Resources/Images/DefaultSynchronize.png | Bin 27764 -> 66468 bytes OpenModelicaArduino/Resources/Images/Interval.png | Bin 25627 -> 225058 bytes .../Resources/Images/ModelPlugLog-nomarkers.png | Bin 32933 -> 172348 bytes .../Resources/Images/ModelPlugLog-withmarkers.png | Bin 30569 -> 510685 bytes OpenModelicaArduino/Resources/Images/PinNumber.png | Bin 3138 -> 36423 bytes .../Resources/Images/QuotedSerialPort.png | Bin 6785 -> 54182 bytes OpenModelicaArduino/Resources/Images/StopTime.png | Bin 15893 -> 224766 bytes .../Resources/Images/SynchronizeSetting.png | Bin 15362 -> 66468 bytes OpenModelicaArduino/package.mo | 75 ++++++++++++--------- 9 files changed, 44 insertions(+), 31 deletions(-) diff --git a/OpenModelicaArduino/Resources/Images/DefaultSynchronize.png b/OpenModelicaArduino/Resources/Images/DefaultSynchronize.png index b1192c1..8dfbc8f 100644 Binary files a/OpenModelicaArduino/Resources/Images/DefaultSynchronize.png and b/OpenModelicaArduino/Resources/Images/DefaultSynchronize.png differ diff --git a/OpenModelicaArduino/Resources/Images/Interval.png b/OpenModelicaArduino/Resources/Images/Interval.png index 849f8f4..514bff0 100644 Binary files a/OpenModelicaArduino/Resources/Images/Interval.png and b/OpenModelicaArduino/Resources/Images/Interval.png differ diff --git a/OpenModelicaArduino/Resources/Images/ModelPlugLog-nomarkers.png b/OpenModelicaArduino/Resources/Images/ModelPlugLog-nomarkers.png index c719a11..ea0e7df 100644 Binary files a/OpenModelicaArduino/Resources/Images/ModelPlugLog-nomarkers.png and b/OpenModelicaArduino/Resources/Images/ModelPlugLog-nomarkers.png differ diff --git a/OpenModelicaArduino/Resources/Images/ModelPlugLog-withmarkers.png b/OpenModelicaArduino/Resources/Images/ModelPlugLog-withmarkers.png index 40ab6da..9549bd2 100644 Binary files a/OpenModelicaArduino/Resources/Images/ModelPlugLog-withmarkers.png and b/OpenModelicaArduino/Resources/Images/ModelPlugLog-withmarkers.png differ diff --git a/OpenModelicaArduino/Resources/Images/PinNumber.png b/OpenModelicaArduino/Resources/Images/PinNumber.png index e45324f..1aff89a 100644 Binary files a/OpenModelicaArduino/Resources/Images/PinNumber.png and b/OpenModelicaArduino/Resources/Images/PinNumber.png differ diff --git a/OpenModelicaArduino/Resources/Images/QuotedSerialPort.png b/OpenModelicaArduino/Resources/Images/QuotedSerialPort.png index cf0c4c3..8702a59 100644 Binary files a/OpenModelicaArduino/Resources/Images/QuotedSerialPort.png and b/OpenModelicaArduino/Resources/Images/QuotedSerialPort.png differ diff --git a/OpenModelicaArduino/Resources/Images/StopTime.png b/OpenModelicaArduino/Resources/Images/StopTime.png index 1ad1767..c7d1662 100644 Binary files a/OpenModelicaArduino/Resources/Images/StopTime.png and b/OpenModelicaArduino/Resources/Images/StopTime.png differ diff --git a/OpenModelicaArduino/Resources/Images/SynchronizeSetting.png b/OpenModelicaArduino/Resources/Images/SynchronizeSetting.png index 41a2924..8dfbc8f 100644 Binary files a/OpenModelicaArduino/Resources/Images/SynchronizeSetting.png and b/OpenModelicaArduino/Resources/Images/SynchronizeSetting.png differ diff --git a/OpenModelicaArduino/package.mo b/OpenModelicaArduino/package.mo index 5c6ebfd..342c1cf 100644 --- a/OpenModelicaArduino/package.mo +++ b/OpenModelicaArduino/package.mo @@ -5,10 +5,10 @@ package OpenModelicaArduino "Connecting OpenModelica with Arduino"

Preparing Your Board

.

The first thing you need to do is upload the Firmware code to your board .

-

\"\"

+

\"\"

Figure 1. Location of the Firmware sketch.

Once the the Firmware code is in the board, you need to write down the serial port that it is using. This is important because you need to give the port name to OpenModelicaArduino in order to communicate with the board. You can find the serial port in Tools->Serial Port or in the bottom-right corner of the Arduino software window (see Figure 2). In Windows the serial port name is something like “COM5”, while in OS X and Linux the name will be something like “/dev/ttyACM0”. Now you are ready to make your first model.

-

\"\"

+

\"\"

Figure 2. Finding the serial port being used. 

Blinking LED

As a first exercise, you are going to reproduce with OpenModelicaArduino the blinking LED example. You can either open the prebuilt example (OpenModelicaArduino.Examples.BlinkLed) or build it by yourself. To build the model, locate the components:

@@ -18,27 +18,27 @@ package OpenModelicaArduino "Connecting OpenModelica with Arduino"
  • Modelica.Blocks.Sources.BooleanPulse

    • Connect the components as in Figure 3. One thing to notice is that the DigitalOutput model is connected to the Arduino component to specify that the pin belongs to that board. This connection is necessary because OpenModelicaArduino can use multiple boards with multiple pins at the same time.

    -

    \"\"

    +

    \"\"

    Figure 3. Diagram of the blinking LED.

    Next you need to specify the serial port that the board is using. This is done by selecting the Arduino component and showing its parameters. In the parameter view, you can find the Port parameter. Write the port name that you got in the section “Preparing your board”. Important: the name must be have quotation marks as shown in Figure 4.

    -

    \"\"

    +

    \"\"

    Figure 4. Specifying the serial port name. 

    Now you need to set the pin number that you are going to use in the DigitalOutput component. Usually, the Arduino boards have an LED attached to pin 13. Set that number in the Pin parameter as shown in Figure 5.

    -

    \"\"

    +

    \"\"

    Figure 5. Specifying the pin to use.

    For the BooleanPulse component, set the 'period' parameter to 1. The model is ready to simulate. Press the simulate button and wait to see the results.

    The first time you run the model, it is probably simulated so fast that you do not have time to react. The reason is that OpenModelica simulates the model as fast as possible. In order to interact with your models using OpenModelicaArduino, it is necessary to synchronize the simulation time with real time. This is done in by using Synchronisation block in ModelicaDeviceDriver library. After simulating the model one time, you need to check in the checkbox “Synchronize with real-time” as shown in Figure 6.

    - //

     \"\"

    + //

     \"\"

    //

    Figure 6. Synchronizing your simulation with real time. 

    //

    If you are building many models with the OpenModelicaArduino library, you should set the “Synchronize with real-time” option as a default simulation setting in SimulationCenter under the menu Tools->Options in the section SimulationCenter->Default Experiment (see Figure 7). 

    - //

    \"\" 

    + //

    \"\" 

    //

    Figure 7. Setting \"Synchronize with real-time\" as default.

    //

    Now run the simulation again and you should see the LED blinking until the simulation reaches the stop time. If you want to keep the simulation running continuously, you need to change the stop time to “infinite” as shown in Figure 8.

    - //

    \"\"

    + //

    \"\"

    //

    Figure 8.  Setting the stop time to infinite.

    //

    If you run the simulation again, you should see the LED blinking continuously.

    One thing that you may have noticed is that OpenModelicaArduino prints status messages in the simulation log (see Figure 9). The first thing it prints is a list of the available ports. In that list, you should see your current port (A). After that, it prints the current port and the speed used (B). Once the port is opened, you receive a notification that the board is initialized (C). Usually the boards report the version of Firmata that you are running. Then you set the sampling interval that the board uses (D). In this example, you can see that you are setting pin 13 to be an output because you have used the DigitalOutput component (E). Finally you will see that the board will send you a list of all the pins available and thier capabilities (F). This list contains the number of the pin and the modes in which it can be used, for example: DigitalInput, DigitalOutput, AnalogInput, AnalogOutput, and Servo.

    -

    \"\"

    +

    \"\"

    Figure 9. Messages shown by OpenModelicaArduino.

    Troubleshooting

    This is a checklist that you can follow in order to solve most of the problems that can occur when using the ModelPlug library:

    @@ -57,6 +57,7 @@ package OpenModelicaArduino "Connecting OpenModelica with Arduino"

    OpenModelicaArduino contains a series of basic examples showing the functionality of the components. You can check the Examples under ModelPlug.Examples. Once you have learned how to use the basic components of OpenModelicaArduino, you can check the Arduino Playground to learn how to connect other sensors and actuators (http://playground.arduino.cc).

    ", revisions = ""), Diagram(coordinateSystem(extent = {{-148.5, -105}, {148.5, 105}}, preserveAspectRatio = true, initialScale = 0.1, grid = {5, 5}))); end GettingStarted; + package Pins "Components to access the board I/O" extends Internal.Icons.Block; @@ -292,7 +293,7 @@ equation

    Description

    This example uses the DigitalOutput component to control the LED attached to the Arduino board on pin 13. It uses a BooleanPulse from the Modelica library to produce an On/Off signal that is fed into the DigitalOutput component. This will make the LED attached to the pin blink.

    You can go ahead and add more LEDs to the board as shown in the following figure. This will require you to add one more DigitalOutput component to control the LED on pin 9.

    -

    \"\"

    ", revisions = ""), Diagram(coordinateSystem(extent = {{-50, -50}, {50, 50}}, initialScale = 0.1, grid = {5, 5}), graphics = {Text(origin = {0, 30}, extent = {{-50, -10}, {50, 10}}, textString = "Blinking an LED", fontSize = 24)})); +

    \"\"/

    ", revisions = ""), Diagram(coordinateSystem(extent = {{-50, -50}, {50, 50}}, initialScale = 0.1, grid = {5, 5}), graphics = {Text(origin = {0, 30}, extent = {{-50, -10}, {50, 10}}, textString = "Blinking an LED", fontSize = 24)})); end BlinkLed; @@ -308,6 +309,11 @@ end BlinkLed; + + + + + model DimmingLed "Changing the intensity of an LED" extends Modelica.Icons.Example; OpenModelicaArduino.Boards.Arduino arduino(Port = "/dev/ttyACM0", ShowPinCapabilities = true) annotation(Placement(visible = true, transformation(origin = {30, -10}, extent = {{-10, -10}, {10, 10}}, rotation = 0))); @@ -326,11 +332,12 @@ end BlinkLed;


    Description

    This example uses the AnalogOutput component to change the light intensity of an LED. AnalogOutput uses the Arduino function 'analogWrite', which produces a PWM (Pulse-Width Modulated) signal. This type of signal can be used to directly control the LED intensity. The following figure shows the connections.

    -

    \"\"

    +

    \"\"

    You can check the Arduino Playground to know more about PWM outputs. 

    ", revisions = ""), Diagram(coordinateSystem(extent = {{-50, -50}, {50, 50}}, preserveAspectRatio = true, initialScale = 0.1, grid = {5, 5}), graphics = {Text(visible = true, origin = {0, 30}, extent = {{-50.857, -10}, {50.857, 10}}, textString = "Dimming LED", fontSize = 24)})); end DimmingLed; + model ReadSensor "Reading analog signals" extends Modelica.Icons.Example; OpenModelicaArduino.Boards.Arduino arduino(Port = "/dev/ttyACM0") annotation(Placement(visible = true, transformation(origin = {0, 15}, extent = {{-10, -10}, {10, 10}}, rotation = 0))); @@ -355,13 +362,14 @@ end BlinkLed;

    Description

    This example shows how to read an analog voltage using the AnalogInput component. The analog signal is then compared to a reference, and if the signal is above the reference, it will turn on an LED. You can see in the following figure how to build this example.

    -

    \"\"

    +

    \"\"

    You can see that pin A0 for the Arduino corresponds to pin number 14 for the Firmata. For other boards, the pin numbering may vary.

    Run the simulation and move the potentiometer. You should see that when the position of the shaft is near the middle, the LED changes state.

    The AnalogInput component returns a signal between 0 and 1. This value represents the voltage between 0 and the reference voltage. If you prefer to get the signal directly in volts, you need to change the 'MaxValue' property to the reference voltage, but generally it is either 5 V or 3.3 V.

    ", revisions = ""), Diagram(coordinateSystem(extent = {{-50, -50}, {50, 50}}, preserveAspectRatio = true, initialScale = 0.1, grid = {5, 5}), graphics = {Text(visible = true, origin = {0, 35}, extent = {{-50, -10}, {50, 10}}, textString = "Reading a Sensor", fontSize = 24)})); end ReadSensor; + model MoveServo "Using servos" extends Modelica.Icons.Example; Boards.Arduino arduino(Port = "COM1") annotation(Placement(visible = true, transformation(origin = {30, -10}, extent = {{-10, -10}, {10, 10}}, rotation = 0))); @@ -381,11 +389,12 @@ end BlinkLed;

    Description

    This example shows how to control a servo by using the Servo component. You can find the diagram in the following figure.

    For this example, it is recommended to use an external power source to provide voltage for the servo. This is because the power from the Arduino may not be enough to supply the servo. If you are not sure how to connect your servo, take a look at the reference in the Arduino Playground (http://playground.arduino.cc).

    -

    \"\"

    +

    \"\"

    Servos are controlled with a signal in the range of 0 to 1, where 0 corresponds to 0 degrees of rotation and 1 to 180 degrees. This example makes the servo bounce from 0 to 180 degrees until it gets stable around 90 degrees.

    ", revisions = ""), Diagram(coordinateSystem(extent = {{-50, -50}, {50, 50}}, preserveAspectRatio = true, initialScale = 0.1, grid = {5, 5}), graphics = {Text(visible = true, origin = {-0, 30}, extent = {{-50, -10}, {50, 10}}, textString = "Controlling a Servo", fontSize = 24)})); end MoveServo; + model SimpleONOFF "A simple On/Off controller" extends Modelica.Icons.Example; OpenModelicaArduino.Boards.Arduino arduino(Port = "/dev/ttyACM0") annotation(Placement(visible = true, transformation(origin = {0, 15}, extent = {{-10, -10}, {10, 10}}, rotation = 0))); @@ -416,11 +425,12 @@ end BlinkLed;

    Description

    This example is a simple ON/OFF controller and can be used for either heating or cooling. It uses an LM35 to read the temperature, and based on that temperature, the controller switches a relay on or off. You can attach a fan or a heater to the relay, depending on the operation you want to perform. You can find the diagram in the following figure.
    Note: You need to be careful when using relays that control electrical equipment using AC voltage, because an incorrect connection may damage your board.

    -

    \"\"

    +

    \"\"

    The target temperature is set by a constant component. The measured temperature is subtracted from the reference in order to obtain the error. The error signal is fed into the hysteresis component, which will send a Boolean signal to control the relay. If you want cooling instead of heating, you need to invert the logic of this signal.

    "), Diagram(coordinateSystem(extent = {{-50, -50}, {50, 50}}, preserveAspectRatio = true, initialScale = 0.1, grid = {5, 5}), graphics = {Text(visible = true, origin = {-0, 35}, extent = {{-50, -10}, {50, 10}}, textString = "Simple ON/OFF Control", fontSize = 24)})); end SimpleONOFF; + model UsingArduinoLeonardo "Basic example of blinking an LED" extends OpenModelicaArduino.Examples.BlinkLed(redeclare ModelPlug.Boards.ArduinoLeonardo arduino); annotation(experiment(StopTime = 10, Interval = 0.001, __Wolfram_SynchronizeWithRealTime = true), Documentation(info = "

    Hardware Components Used 

    @@ -431,10 +441,11 @@ end BlinkLed;

    Description

    This example shows how the - BlinkLed can be used with an Arduino Leonardo.

    ", revisions = "")); + Blink Led can be used with an Arduino Leonardo.

    ", revisions = "")); end UsingArduinoLeonardo; + model UsingCustomBoard "Using a Firmata-compatible board" extends Modelica.Icons.Example; Modelica.Blocks.Sources.BooleanPulse booleanPulse(period = 1) annotation(Placement(visible = true, transformation(origin = {-30, -10}, extent = {{-10, -10}, {10, 10}}, rotation = 0))); @@ -447,7 +458,7 @@ end BlinkLed;

    - 1 Teensy 3.1 board

    Description

    This example shows how to use a board with a custom version of Firmata. The Teensy board works perfectly with the StandardFirmata, but in this example it is modified in order get a faster data transfer speed.

    -

    \"\"

    +

    \"\"


    The main difference of the CustomFirmata component is that it allows you to set the baud rate to the sampling interval that you want to use. In this case the oce of the StandardFirmata is modified to use a baud rate of 115200. You can perform this modification in the source code. Search for the line:

    Firmata.Begin(57600);

    and changing it to

    @@ -457,10 +468,12 @@ end BlinkLed;

    and changing it to

    #define MINIMUM_SAMPLING_INTERVAL 1

    This changes the sampling interval limit from 10 ms to 1ms. You have to consider that this change is possible because the Teensy board can run up to 96 MHz. If you change the sampling interval, it is necessary to change the simulation setting in SimulationCenter to 1 ms, as shown in the following figure.

    -

    \"\"

    ", revisions = ""), Diagram(coordinateSystem(extent = {{-50, -50}, {50, 50}}, preserveAspectRatio = true, initialScale = 0.1, grid = {5, 5}), graphics = {Text(visible = true, origin = {0, 30}, extent = {{-50, -10}, {50, 10}}, textString = "Using a Custom Board", fontSize = 24)})); +

    \"\"

    ", revisions = ""), Diagram(coordinateSystem(extent = {{-50, -50}, {50, 50}}, preserveAspectRatio = true, initialScale = 0.1, grid = {5, 5}), graphics = {Text(visible = true, origin = {0, 30}, extent = {{-50, -10}, {50, 10}}, textString = "Using a Custom Board", fontSize = 24)})); end UsingCustomBoard; + + model UsingStandardFirmata "Using a standard Firmata board" extends Modelica.Icons.Example; Boards.StandardFirmata standardFirmata(Port = "COM1", ShowPinCapabilities = true) annotation(Placement(visible = true, transformation(origin = {30, -10}, extent = {{-10, -10}, {10, 10}}, rotation = 0))); @@ -478,7 +491,7 @@ end BlinkLed;

    Description

    This example uses the DigitalOutput component to control the LED attached to a standard Firmata board on pin 13. It uses a BooleanPulse from the Modelica library to produce an On/Off signal that is fed into the DigitalOutput component. This will make the LED attached to the pin blink.

    You can go ahead and add more LEDs to the board as shown in the following figure. This will require you to add one more DigitalOutput component to control the LED on pin 9.

    -

    \"\"

    ", revisions = ""), Diagram(coordinateSystem(extent = {{-50, -50}, {50, 50}}, preserveAspectRatio = true, initialScale = 0.1, grid = {5, 5}), graphics = {Text(visible = true, origin = {-0, 30}, extent = {{-50, -10}, {50, 10}}, textString = "Using Standard Firmata", fontSize = 24)})); +

    \"\"

    ", revisions = ""), Diagram(coordinateSystem(extent = {{-50, -50}, {50, 50}}, preserveAspectRatio = true, initialScale = 0.1, grid = {5, 5}), graphics = {Text(visible = true, origin = {-0, 30}, extent = {{-50, -10}, {50, 10}}, textString = "Using Standard Firmata", fontSize = 24)})); end UsingStandardFirmata; annotation(Diagram(coordinateSystem(extent = {{-148.5, -105}, {148.5, 105}}, preserveAspectRatio = true, initialScale = 0.1, grid = {5, 5}))); @@ -597,7 +610,7 @@ end BlinkLed; end Internal; annotation(preferredView = "info", Diagram(coordinateSystem(extent = {{-148.5, -105}, {148.5, 105}}, preserveAspectRatio = true, initialScale = 0.1, grid = {5, 5})), Documentation(info = "

    What Is ModelPlug?

    ModelPlug is a library that allows you to connect your simulations with the real world. It uses an Arduino board (or compatible) to send analog and digital signals to physical devices and receive signals from them.

    -

    \"\"

    +

    \"\"

    What Can You Do with It?