Flowcode Help - User contributions [en]

Component: LoRaWAN (Seeed WIO-E5) (LORAWAN-E5) (Comms: IoT/Cloud)

2025-06-09T21:24:36Z

Kersing:

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Jac Kersing
|-
| width="20%" style="color:gray;" | Version
| 1.0
|-
| width="20%" style="color:gray;" | Category
| Comms: IoT/Cloud
|}

==LoRaWAN (Seeed WIO-E5) component==
LoRaWAN Component for the Seeed WIO-E5 module.

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

===LoraWAN Demo===

Example LoRaWAN demo file.

{{Fcfile|lorawan-demo-bl0080.fcfx|LoRaWAN Demo}}

==Macro reference==

===ChkConnected===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ChkConnected'''
|-
| colspan="2" | Sends AT command and checks response to check the LoRa E5 module is connected to the controller. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===FreeUart===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''FreeUart'''
|-
| colspan="2" | Release UART resources (to allow for sleeping on some microcontrollers) 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===GetDownlinkByte===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetDownlinkByte'''
|-
| colspan="2" | Get one byte from the received downlink message, returns -1 if no more bytes are available. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===GetId===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetId'''
|-
| colspan="2" | Get the specified ID from the LoRaWAN module. Valid types are DevEUI, AppEUI and DevAddr  
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | type
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===GetPort===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetPort'''
|-
| colspan="2" | Get the portnumber of the downlink message. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===GotDownlink===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GotDownlink'''
|-
| colspan="2" | Was a downlink received? 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Initialize===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialize'''
|-
| colspan="2" | Initialize the component. Should be called before any other function is used but after the component received a hardware reset. (Toggle of the reset pin) 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===Join===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Join'''
|-
| colspan="2" | Execute a join command to have the module join the LoRaWAN network. Returns 1 on a successfull join, 0 if the join failed. Keep in mind there is no interaction with the LoRaWAN network if Join mode is ABP so it will always succeed if all parameters have been initialized correctly. In Join mode OTAA a join will fail if the module does not get a valid response from teh network which may occur if the DevEUI, AppEUI or AppKey are not correct or if there is no coverage at the location. 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===LowPowerSleep===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''LowPowerSleep'''
|-
| colspan="2" | Set low power sleep mode. Specify the number of seconds to sleep in the range 6-12959. 
|-
|-
| width="10%" align="center" | [[File:Fc9-s16-icon.png]] - INT
| width="90%" | seconds
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===ReInitUart===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReInitUart'''
|-
| colspan="2" | Reclaim the UART after low power sleep of the CONTROLLER (not the LoRaWAN module). 
|-
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SendMsg===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendMsg'''
|-
| colspan="2" | Send LoRaWAN message, the message should be an array of byte values. To conserve airtime no ASCII strings should be used. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | msg
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | len
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SendMsgConfirmed===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SendMsgConfirmed'''
|-
| colspan="2" | Send a confirmed LoRaWAN message, the message should be an array of byte values. To conserve airtime no ASCII strings should be used. Use confirmed messages sparingly as transmitting gateways can normally receive 8 parallel messages but not 1 message while transmitting. So it kills scalebility of a LoRaWAN network! 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | msg
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | len
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetDr===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetDr'''
|-
| colspan="2" | Explicitly set DataRate of transmissions. Valid values depend on the region used please consult the LoRaWAN regional parameter document to find them. 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | dr
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetId===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetId'''
|-
| colspan="2" | Set an ID. Valid options are "AppEUI", "DevEUI" and "DevAddr". The value to use is an 16 HEX character long string for EUIs or a 8 HEX characters long string for DevAddr. Examples: AppEUI: "001122334455AABB" DevAddr: "001122AA" 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | type
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | value
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetJoinMode===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetJoinMode'''
|-
| colspan="2" | Set the join mode, valid options are MODE_OTAA or MODE_ABP. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | mode
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetKey===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetKey'''
|-
| colspan="2" | Set encryption key. Valid key types are: "APPKEY", "APPSKEY" and "NWKSKEY". For OTAA only APPKEY is required. For ABP both APPSKEY and NWKSKEY are required. The value shoud be a 32 HEX character string. Example value: "00112233445566778899AABBCCDDEEFF" 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | type
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | value
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetLowPower===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetLowPower'''
|-
| colspan="2" | Set the Low Power mode of the module. Low power can be off (false) or on (true) 
|-
|-
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL
| width="90%" | on
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetPort===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetPort'''
|-
| colspan="2" | Set the port used for transmissions 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | port
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===SetRegion===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetRegion'''
|-
| colspan="2" | Set the LoRaWAN region to be used. For US915 the band (of 8 channels) to be used needs to be specified as well, the band is ignored for EU868 TTN uses band 1 in US915. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | region
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | band
|-
| colspan="2" |  
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

==Property reference==

{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
|-
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
|-
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | LoRaWAN settings
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Max Downlink Size
|-
| colspan="2" | Sets the number of byte elements inside the circular buffer. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | UART Channel selector Software channels are bit banged using generic I/O pins but are not as reliable as hardware channels. Hardware channels use the selected peripheral on-board the target microcontroller. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Baud Options
|-
| colspan="2" | Baud rate option selector 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | TX
|-
| colspan="2" | Pin to be used for Transmit data 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | TX Remap Pin
|-
| colspan="2" | Allows the hardware transmit pin to be configured from a list of available pins based on your target device, 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | RX
|-
| colspan="2" | Pin to be used for Receive data 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | RX Remap Pin
|-
| colspan="2" | Allows the hardware receive pin to be configured from a list of available pins based on your target device, 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
|-
|-
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
| width="90%" | Console Data
|-
| colspan="2" | Selects if the console data is automatically generated or not 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Console Format
|-
| colspan="2" | Controls if the data is shown as a log with time and date stamps or just as raw data 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Console Columns
|-
| colspan="2" | Number of characters that can be displayed on a single line of the console. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Data Source
|-
| colspan="2" | Simulation data source used to allow the component to connect to various remote devices Nothing - Simulation data is ignored COM port - Routes the communication data to and from a physical or virtual COM port API - Routes the communication data via a data injector component on the Panel. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | API
|-
| colspan="2" | Selects which API component to route the communication data via. Add API components to the panel before they will be available in this list. API components are available from the Comms component category. 
|}

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_lora-e5-component.fcfx FC_Comp_Source_lora-e5-component.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_lora-e5-component.fcfx FC_Comp_Source_lora-e5-component.fcfx]

String Manipulation Functions

2016-09-04T22:09:51Z

Kersing: /* Concatenating Strings */

<sidebar>Sidebar: Flowcode Help Overview:Functions</sidebar>
:''See [[Calculation Icon Properties]]''

__TOC__

==String Functions==

The String functions are a set of string manipulation functions that can be used to edit, change and examine the strings.

To add a function, drag it into the calculation box. The user can then edit this base code with the variables required.

{| style="margin:auto; text-align:center;"
|-
|[[File:Btn_Calculation.gif|border]]
| width="50px" |→
|[[File:Gen_Calculation_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Gen_StringFunctions_01.jpg]]
|}

Example Strings used in explaining the functions below:

Str1[20]

Str2[20]

TestStr[40]

===Assigning Strings===

=

To assign a string value to a string variable you can simply use the = character.

Str1 = "Hello "

Str2 = "World"

Strings can also be treated like byte arrays to allow you to manipulate the individual bytes. For string data to work correctly with other string functions the end of the data must be signified with a 0 or null byte.

Str1[0] = 'H'

Str1[1] = 'e'

Str1[2] = 'l'

Str1[3] = 'l'

Str1[4] = 'o'

Str1[5] = ' '

Str1[6] = 0

Assigning a string constant to a string variable will automatically add the null byte to the end of the string for you.

Str1 = "Hello "

Strings can also be used with escape characters such as \n (newline), \r (carriage return), \t (tab), \xXX (hexadecimal byte value), \\ single backslash character.

Str1 = "Hello\n\rWorld"

===Concatenating Strings===

+

Concatenates the two string together in the order presented from left to right.

If the resulting string is longer than the array size of the receiving string then any extra characters are lost.

Str1 = "Hello "

Str2 = "World"

TestStr = Str1 + Str2

TestStr is now "Hello World"

Multiple concatenations are best done like this to avoid using excess memory. Note that each line contains only two values to be added together.

TestStr = "Multiple " + Str1

TestStr = TestStr + Str2

TestStr is now "Multiple Hello World"

'''NOTE:''' Due to a limitation in generated code the result of multiple concatenations in one operation is limited to 20 characters. So the result of Str1 + Str2 + Str3 should not exceed 20 characters.

===Converting a numeric value/variable to a string===

'''ToString$(value)'''

Changes the numeric value to a String.

TestStr = ToStr$(1234)

TestStr is now "1234"

===Converting a string to upper case===

'''ToUpper$(string)'''

Changes all letters to upper case.

TestStr = ToUpper$(Str1)

TestStr is now "HELLO "

===Converting a string to lower case===

'''ToLower$(string)'''

Changes all letters to lower case.

TestStr = ToLower$(Str1)

TestStr is now "hello "

===Finding the length of a string===

'''Length$(string)'''

Retrieves the length of the string.

This is not the Array size, but the number of characters in the array before a Null character is encountered.

RetVal = Length$(Str1)

RetVal is now 6

Note: Str1 array size is 20, but has a String of only 6 characters currently assigned to it hence the return value of 6.

===String subset - characters from the start of the string===

'''Left$(string, size)'''
Retrieves a substring from the string of size characters starting from the leftmost character.

If the length of the string used to store the result is less than size of the substring returned then any extra characters are lost.

TestStr = Left$(Str1, 3)

TestStr is now "Hel"

===String subset - characters from the end of the string===

'''Right$(string, size)'''

Retrieves a substring from the string of size characters starting from the rightmost character.

i.e. a size of 4 retrieves the 4 rightmost characters.

If the length of the string used to store the result is less than size of the substring returned then any extra characters are lost.

TestStr = Right$(Str1, 3)

TestStr is now "lo "

===String subset - characters from an arbitrary position in the string===

'''Mid$(string, start, size)'''

Retrieves a substring from the string starting at position start of size characters. The first character of the string is at position zero.

If the length of the string used to store the result is less than size of the substring returned then any extra characters are lost.

TestStr = Mid$(Str1, 2, 3)

TestStr is now "llo"

===String comparisons===

'''Compare$(string1, string2, compare_type)'''

Compares the two strings, parameters 1 and 2, and returns a BYTE value corresponding to the following results:

0 = strings are identical

1 = string1>string2

255 = string2>string1

The 3rd parameter, compare_type, determines whether or not the check is case sensitive. values for compare_type are:

0 = case sensitive

1 = case insensitive.

Examples

Str1 = "ABC"

Str2 = "abc"

RetVal = Compare$(Str1, Str2, 0)

RetVal is now 255 as Str2 is later in the ASCII sequence.

RetVal = Compare$(Str1, Str2, 1)

RetVal is now 0 as when case insensitive the two strings are identical.

Str2 = Str1

RetVal = Compare$(Str1, Str2, 0)

RetVal is now 0 as both strings are identical.

{{Fcfile|StringCompare.fcfx|String Compare Example}}

===Converting a floating point value/variable to a string===

'''FloatToString$( float )'''

Converts a floating point number into a string.

float = Floating point number to convert.

string = String variable to hold the conversion data.

string = FloatToString( float )

===Converting a numeric value/variable to a hex string===

'''NumberToHex$( number )'''

Converts a byte or int number into a hexadecimal string.

number = byte or integer number to convert.

string = String variable to hold the conversion data.

string = FloatToString( INT )

===Converting a string to a numeric value/variable===

'''StringToInt$(string)'''

Converts a string of numeric ASCII data into an integer numeric data value.

string = String variable containing numeric ASCII data.

returns numeric data from the string in decimal form.

number = StringToInt$( string )

===Converting a string into a floating point value/variable===

'''StringToFloat$( string )'''

Converts a string of numeric ASCII data into a floating point variable.

string = String variable containing numeric ASCII data.

returns numeric data from the string in floating point form.

float = StringToFloat$( string )

Variable Types

2015-12-07T22:38:51Z

Kersing: /* STRING */

<sidebar>Sidebar: Flowcode Help Overview:Variables</sidebar>
[[File:Gen Create a New Variable Window.png|right|254x303px]]
A variable type defines what can be represented by that variable, as well as the ammount of storage the variable will take up.

==Integer types==
'''Signed''' integers can be positive or negative, but there is no fractional part. They are typically used in maths or graphical areas, but not so much when dealing with individual bits.

'''Unsigned''' integers can only be positive. Unsigned integers will double the range of a variable if it is known the value can never be negative. Unsigned integers are useful for ''bit-masking'' and other logical operations, but are not usually used in mathematical operations as these will usually require a signed value.

===BOOL===
{|
|-
| scope="col" width="50%"| Range:
| 0 or 1
|-
| scope="col" width="50%"| Bit Depth:
| 1-bit unsigned integer
|}
A Boolean value is either '''true''' or '''false'''. In Flowcode, this means 1 or 0, respectively. On download, this may take up 1 byte or a single bit, depending on the compiler.

Boolean values are used typically to set flags. Though internally a BOOL is stored as an integer, it is considered bad practice to mix Boolean values and integers in expressions.

===BYTE===
{|
|-
| scope="col" width="50%"| Range:
| 0 to 255
|-
| scope="col" width="50%"| Bit Depth:
| 8-bit unsigned integer
|}
A byte is the smallest storage unit most processors are able to read from in a single instruction. A byte can be used to store a single value or its bits may be used as ''flags'', almost like a compact array of BOOLs.

===INT===
{|
|-
| scope="col" width="50%"| Range:
| -32768 to 32767
|-
| scope="col" width="50%"| Bit Depth:
| 16-bit signed integer
|}

===UINT===
{|
|-
| scope="col" width="50%"| Range:
| 0 to 65535
|-
| scope="col" width="50%"| Bit Depth:
| 16-bit unsigned integer
|}

===LONG===
{|
|-
| scope="col" width="50%"| Range:
| -21474836648 to 21474836647
|-
| scope="col" width="50%"| Bit Depth:
| 32-bit signed integer
|}
A 32-bit integer is useful for processing larger values and most integer-arithmetic uses found in embedded devices.

===ULONG===
{|
|-
| scope="col" width="50%"| Range:
| 0 to 4294967295
|-
| scope="col" width="50%"| Bit Depth:
| 32-bit unsigned integer
|}
An unsigned 32-bit value offers the largest integer value of any of the types, and because of this, many of the simulation-only functions in Flowcode use ULONG, because simulation memory is not a consideration.

==Floating point==
A floating point value can represent a much wider range of values than an integer can, but at a loss of accuracy over large ranges. Floating point values when downloaded will be 64-bit if the target supports them, or 32-bit if it does not.

===FLOAT===
{|
|-
| scope="col" width="50%"| Range:
| -Infinite to +Infinite
|-
| scope="col" width="50%"| Bit Depth:
| 32-bit signed
|}

==Special types==
Flowcode also supports some structured types to help with programs.

===STRING===
{|
|-
| scope="col" width="50%"| Range:
| 0 to 255 per character
|-
| scope="col" width="50%"| Bit Depth:
| 8-bit unsigned array. Default size of the array is 20.
|}
A string is a byte-array used to store text. Hence in many circumstances a string and a byte array are interchangeable.

One important difference is in Flowcode strings terminate at a null (0x00) character. This means the first zero-value byte that is encountered in the string marks the end of the string. If a string contains the exact number of characters specified in the declaration it will not contain a terminating zero, in all other cases it will.

===HANDLE===
{|
|-
| scope="col" width="50%"| Range:
| Undefined
|-
| scope="col" width="50%"| Bit Depth:
| 32-bit unsigned value
|}
An object handle is used to reference a more complicated piece of data (such as a file, Flowcode component or block of text) whose internal format is not known. Flowcode provides many [[API Overview|simulation macros]] that use handles to easily pass data around.

In an embedded context, a handle can be thought of as a pointer to memory, except Flowcode manages the handles so referencing a non-existent handle will not cause any fatal errors.

A handle value of zero is considered ''null'' and invalid to Flowcode.

Variable Types

2015-12-07T17:05:29Z

Kersing: /* STRING */

<sidebar>Sidebar: Flowcode Help Overview:Variables</sidebar>
[[File:Gen Create a New Variable Window.png|right|254x303px]]
A variable type defines what can be represented by that variable, as well as the ammount of storage the variable will take up.

==Integer types==
'''Signed''' integers can be positive or negative, but there is no fractional part. They are typically used in maths or graphical areas, but not so much when dealing with individual bits.

'''Unsigned''' integers can only be positive. Unsigned integers will double the range of a variable if it is known the value can never be negative. Unsigned integers are useful for ''bit-masking'' and other logical operations, but are not usually used in mathematical operations as these will usually require a signed value.

===BOOL===
{|
|-
| scope="col" width="50%"| Range:
| 0 or 1
|-
| scope="col" width="50%"| Bit Depth:
| 1-bit unsigned integer
|}
A Boolean value is either '''true''' or '''false'''. In Flowcode, this means 1 or 0, respectively. On download, this may take up 1 byte or a single bit, depending on the compiler.

Boolean values are used typically to set flags. Though internally a BOOL is stored as an integer, it is considered bad practice to mix Boolean values and integers in expressions.

===BYTE===
{|
|-
| scope="col" width="50%"| Range:
| 0 to 255
|-
| scope="col" width="50%"| Bit Depth:
| 8-bit unsigned integer
|}
A byte is the smallest storage unit most processors are able to read from in a single instruction. A byte can be used to store a single value or its bits may be used as ''flags'', almost like a compact array of BOOLs.

===INT===
{|
|-
| scope="col" width="50%"| Range:
| -32768 to 32767
|-
| scope="col" width="50%"| Bit Depth:
| 16-bit signed integer
|}

===UINT===
{|
|-
| scope="col" width="50%"| Range:
| 0 to 65535
|-
| scope="col" width="50%"| Bit Depth:
| 16-bit unsigned integer
|}

===LONG===
{|
|-
| scope="col" width="50%"| Range:
| -21474836648 to 21474836647
|-
| scope="col" width="50%"| Bit Depth:
| 32-bit signed integer
|}
A 32-bit integer is useful for processing larger values and most integer-arithmetic uses found in embedded devices.

===ULONG===
{|
|-
| scope="col" width="50%"| Range:
| 0 to 4294967295
|-
| scope="col" width="50%"| Bit Depth:
| 32-bit unsigned integer
|}
An unsigned 32-bit value offers the largest integer value of any of the types, and because of this, many of the simulation-only functions in Flowcode use ULONG, because simulation memory is not a consideration.

==Floating point==
A floating point value can represent a much wider range of values than an integer can, but at a loss of accuracy over large ranges. Floating point values when downloaded will be 64-bit if the target supports them, or 32-bit if it does not.

===FLOAT===
{|
|-
| scope="col" width="50%"| Range:
| -Infinite to +Infinite
|-
| scope="col" width="50%"| Bit Depth:
| 32-bit signed
|}

==Special types==
Flowcode also supports some structured types to help with programs.

===STRING===
{|
|-
| scope="col" width="50%"| Range:
| 0 to 255 per character
|-
| scope="col" width="50%"| Bit Depth:
| 8-bit unsigned array. Default size of the array is 20.
|}
A string is a byte-array used to store text. Hence in many circumstances a string and a byte array are interchangeable.

One important difference is in Flowcode strings terminate at a zero character. This means the first zero-value byte that is encountered in the string marks the end of the string. If a string contains the exact number of characters specified in the declaration it will not contain a terminating zero, in all other cases it will.

===HANDLE===
{|
|-
| scope="col" width="50%"| Range:
| Undefined
|-
| scope="col" width="50%"| Bit Depth:
| 32-bit unsigned value
|}
An object handle is used to reference a more complicated piece of data (such as a file, Flowcode component or block of text) whose internal format is not known. Flowcode provides many [[API Overview|simulation macros]] that use handles to easily pass data around.

In an embedded context, a handle can be thought of as a pointer to memory, except Flowcode manages the handles so referencing a non-existent handle will not cause any fatal errors.

A handle value of zero is considered ''null'' and invalid to Flowcode.

Internal Oscillator

2015-07-22T07:26:22Z

Kersing:

<sidebar>Sidebar: Flowcode Help Overview:ChipSpecific</sidebar>
A lot of the devices have an inbuilt oscillator which can be used to reduce the number of devices required to drive the microcontroller.

The device datasheet should detail the type of oscillator available to the device.

Here we have the datasheet for the PIC16F88 device listing the options available for the internal oscillator.

[[File:16F88OscCon.jpg]]

Using a C code icon at the very top of the Main macro we can specify which speed the microcontroller should start-up with.

To access a register using PIC use the register name in all lower case. e.g. "osccon"

For the PIC 16 bit devices (dsPIC and PIC24) and AVR use the register name in all upper case. e.g. "OSCCON"

Remember to end the line of C code with a semicolon to mark the end of the instruction.

Here is an example to configure the internal oscillator to 8MHz on the PIC16F88.

[[File:16F88IntOsc1.jpg]]

Here is an example to configure the internal oscillator to 1MHz on the PIC16F88.

[[File:16F88IntOsc2.jpg]]

Be sure to set the clock speed in the project options to the same speed to allow your delays and any communications baud rates to be correct.

[[File:16F88IntOscProj.jpg]]

The configuration settings will also need to be edited from the default HS type oscillator to the IntOsc setting.

[[File:16F88IntOscConf.jpg]]

A [[One second LED flasher]] test can be very useful to confirm if your device is actually running at the intended speed.

String Manipulation Functions

2015-07-10T15:16:34Z

Kersing:

<sidebar>Sidebar: Flowcode Help Overview:Functions</sidebar>
:''See [[Calculation Icon Properties]]''

__TOC__

==String Functions==

The String functions are a set of string manipulation functions that can be used to edit, change and examine the strings.

To add a function, drag it into the calculation box. The user can then edit this base code with the variables required.

{| style="margin:auto; text-align:center;"
|-
|[[File:Btn_Calculation.gif|border]]
| width="50px" |→
|[[File:Gen_Calculation_Flowchart_Icon_01.png]]
|width="50px" |→
|[[File:Gen_StringFunctions_01.jpg]]
|}

Example Strings used in explaining the functions below:

Str1[10]

Str2[10]

TestStr[30]

===Assignment and Concatenation===

=

To assign a string value to a string variable you can simply use the = character.

Str1 = "Hello "

Str2 = "World"

+

Concatenates the two string together in the order presented from left to right.

If the resulting string is longer than the array size of the receiving string then any extra characters are lost.

TestStr = Str1 + Str2

TestStr is now "Hello World"

Multiple concatenations are best done like this to avoid using excess memory. Note that each line contains only two values to be added together.

TestStr = "Multiple " + Str1

TestStr = TestStr + Str2

TestStr is now "Multiple Hello World"

===Converting a numeric value/variable to a string===

'''ToString$(value)'''

Changes the numeric value to a String.

TestStr = ToStr$(1234)

TestStr is now "1234"

===Converting a string to upper case===

'''ToUpper$(string)'''

Changes all letters to upper case.

TestStr = ToUpper$(Str1)

TestStr is now "HELLO "

===Converting a string to lower case===

'''ToLower$(string)'''

Changes all letters to lower case.

TestStr = ToLower$(Str1)

TestStr is now "hello "

===Finding the length of a string===

'''Length$(string)'''

Retrieves the length of the string.

This is not the Array size, but the number of characters in the array before a Null character is encountered.

RetVal = Length$(Str1)

RetVal is now 6

Note: Str1 array size is 20, but has a String of only 6 characters currently assigned to it hence the return value of 6.

===String subset - characters from the start of the string===

'''Left$(string, size)'''
Retrieves a substring from the string of size characters starting from the leftmost character.

If the length of the string used to store the result is less than size of the substring returned then any extra characters are lost.

TestStr = Left$(Str1, 3)

TestStr is now "Hel"

===String subset - characters from the end of the string===

'''Right$(string, size)'''

Retrieves a substring from the string of size characters starting from the rightmost character.

i.e. a size of 4 retrieves the 4 rightmost characters.

If the length of the string used to store the result is less than size of the substring returned then any extra characters are lost.

TestStr = Right$(Str1, 3)

TestStr is now "lo "

===String subset - characters from an arbitrary position in the string===

'''Mid$(string, start, size)'''

Retrieves a substring from the string starting at position start of size characters. The first character of the string is at position zero.

If the length of the string used to store the result is less than size of the substring returned then any extra characters are lost.

TestStr = Mid$(Str1, 2, 3)

TestStr is now "llo"

===String comparisons===

'''Compare$(string1, string2, compare_type)'''

Compares the two strings, parameters 1 and 2, and returns a BYTE value corresponding to the following results:

0 = strings are identical

1 = string1>string2

255 = string2>string1

The 3rd parameter, compare_type, determines whether or not the check is case sensitive. values for compare_type are:

0 = case sensitive

1 = case insensitive.

Examples

Str1 = "ABC"

Str2 = "abc"

RetVal = Compare$(Str1, Str2, 0)

RetVal is now 255 as Str2 is later in the ASCII sequence.

RetVal = Compare$(Str1, Str2, 1)

RetVal is now 0 as when case insensitive the two strings are identical.

Str2 = Str1

RetVal = Compare$(Str1, Str2, 0)

RetVal is now 0 as both strings are identical.

===Converting a floating point value/variable to a string===

'''FloatToString$( float )'''

Converts a floating point number into a string.

float = Floating point number to convert.

string = String variable to hold the conversion data.

string = FloatToString( float )

===Converting a numeric value/variable to a hex string===

'''NumberToHex$( number )'''

Converts a byte or int number into a hexadecimal string.

number = byte or integer number to convert.

string = String variable to hold the conversion data.

string = FloatToString( INT )

===Converting a string to a numeric value/variable===

'''StringToInt$(string)'''

Converts a string of numeric ASCII data into an integer numeric data value.

string = String variable containing numeric ASCII data.

returns numeric data from the string in decimal form.

number = StringToInt$( string )

===Converting a string into a floating point value/variable===

'''StringToFloat$( string )'''

Converts a string of numeric ASCII data into a floating point variable.

string = String variable containing numeric ASCII data.

returns numeric data from the string in floating point form.

float = StringToFloat$( string )

Flash EEPROM component

2014-12-21T22:21:48Z

Kersing:

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| The-Box Development
|-
| width="20%" style="color: gray;" | Version
| 1.0
|-
| width="20%" style="color: gray;" | License
| BSD
|-
| width="20%" style="color: gray;" | Category
| Storage
|}

==[[File:Flash-eeprom.png|Image]] Flash EEPROM component==
The Flash EEPROM component provides EEPROM emulation for PIC24 and dsPIC series controllers using Flash memory.
The component simulates persistence between runs using an external file to store the information.

The component provides storage for 253 words of 16 bits (UINT).

The component uses a wear leveling algorithm which requires 2 full 'erase' pages of memory. The 'erase' page size for a particular device
can be found in the data sheet. Look for the 'erase program memory block size', typically a value of 1536 or 3072 bytes (512 or 1536 words).

'''NOTE''' The component stores values in primary flash. This part of flash memory will be wiped when programming new code to the controller!

==Downloadable macro reference==

===<tt>Initialise</tt>===
Initialize the internal state of the component.

'''Parameters'''

''No parameters''

'''Return value'''

:[[Variable Types|BYTE]]
The macro returns 0 when successful. Any value unequal 0 means failure.

===<tt>Read</tt>===
Reads one word of 16 bits (UINT).

'''Parameters'''

:[[Variable Types|Byte]] ''address''
::The address to read the data from. The address should not exceed 253.

'''Return value'''

:[[Variable Types|UINT]]

===<tt>Write</tt>===
Write a 16 bit word (UINT) to memory.

'''Parameters'''

:[[Variable Types|BYTE]] ''address''
::The address to write the data to. The address should not exceed 253.

:[[Variable Types|UINT]] ''value''
::The 16 bit value to store.

'''Return value'''

:[[Variable Types|BYTE]]
The macro returns 0 when successful. Any value unequal 0 means failure.

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Simulation file

This property is of type ''Filename''

The name of the file to store data during simulation runs.

Auto Address

This property is of type ''True or false'' and can be referenced with the variable name ''AUTOADDR''.

If set to 'Yes' the component will automatically allocate the required flash memory. If set to ''No'' the property ''Address''
should be set to a valid value.

Address

This property is of type ''Unsigned Integer'' and can be referenced with the variable name ''FLASHADDRESS''.

This property is only available if ''Auto Address'' is set to ''No''. Set to a valid address in flash memory beyond the
end address of the program. The value must be at the start of an 'erase' page and there should be at least two full 'erase'
pages of flash available after the address. Do not use this feature if you are unsure which address can safely be used.

==Download==
The component can be downloaded from the [http://www.matrixtsl.com/mmforums/viewtopic.php?f=58&t=15932 Matrix user forum]

Flash EEPROM component

2014-12-21T22:21:27Z

Kersing:

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| The-Box Development
|-
| width="20%" style="color: gray;" | Version
| 1.0
|-
| width="20%" style="color: gray;" | License
| BSD
|-
| width="20%" style="color: gray;" | Category
| Storage
|}

==[[File:Flash-eeprom.png|Image]] Flash EEPROM component==
The Flash EEPROM component provides EEPROM emulation for PIC24 and dsPIC series controllers using Flash memory.
The component simulates persistence between runs using an external file to store the information.

The component provides storage for 253 words of 16 bits (UINT).

The component uses a wear leveling algorithm which requires 2 full 'erase' pages of memory. The 'erase' page size for a particular device
can be found in the data sheet. Look for the 'erase program memory block size', typically a value of 1536 or 3072 bytes (512 or 1536 words).

'''NOTE''' The component stores values in primary flash. This part of flash memory will be wiped when programming new code to the controller!

==Downloadable macro reference==

===<tt>Initialise</tt>===
Initialize the internal state of the component.

'''Parameters'''

''No parameters''

'''Return value'''

:[[Variable Types|BYTE]]
The macro returns 0 when successful. Any value unequal 0 means failure.

===<tt>Read</tt>===
Reads one word of 16 bits (UINT).

'''Parameters'''

:[[Variable Types|Byte]] ''address''
::The address to read the data from. The address should not exceed 253.

'''Return value'''

:[[Variable Types|UINT]]

===<tt>Write</tt>===
Write a 16 bit word (UINT) to memory.

'''Parameters'''

:[[Variable Types|BYTE]] ''address''
::The address to write the data to. The address should not exceed 253.

:[[Variable Types|UINT]] ''value''
::The 16 bit value to store.

'''Return value'''

:[[Variable Types|BYTE]]
The macro returns 0 when successful. Any value unequal 0 means failure.

==Simulation macro reference==

''This component does not contain any simulation macros''

==Property reference==
Simulation file

This property is of type ''Filename''

The name of the file to store data during simulation runs.

Auto Address

This property is of type ''True or false'' and can be referenced with the variable name ''AUTOADDR''.

If set to 'Yes' the component will automatically allocate the required flash memory. If set to ''No'' the property ''Address''
should be set to a valid value.

Address

This property is of type ''Unsigned Integer'' and can be referenced with the variable name ''FLASHADDRESS''.

This property is only available if ''Auto Address'' is set to ''No''. Set to a valid address in flash memory beyond the
end address of the program. The value must be at the start of an 'erase' page and there should be at least two full 'erase'
pages of flash available after the address. Do not use this feature if you are unsure which address can safely be used.

==Component==
The component can be downloaded from the [http://www.matrixtsl.com/mmforums/viewtopic.php?f=58&t=15932 Matrix user forum]

Flash EEPROM component

2014-12-21T21:57:47Z

Kersing: Flash EEPROM component

File:Flash-eeprom.png

2014-12-21T21:21:48Z

Kersing:

DLL Support

2014-11-24T23:25:58Z

Kersing:

<sidebar>Sidebar: Flowcode Help Overview:Simulation</sidebar>
==DLLs included with Flowcode==

A DLL or Dynamic Link Library is a common way of wrapping a set of software functions up into a library that can be called by an application. They are usually created to allow programs to do certain tasks without having to rewrite the task and re-compile the code each time. In Windows there are DLL calls to allow you to create and control application windows, play and record audio as well as a whole host of other things.

Some of the components that are packaged with Flowcode already come with their own DLL files built in to allow the components to do things like this:

Collect the system time and date - [[Component:_Injector_(GPS_NMEA)_(Simulation)|GPS NMEA Data Injector Component]]

Synthesize speech - [[Component:_Speech_(Outputs)|Speech Component]]

Communicate over USB - [[Component:_USB_Serial_(Comms)|USB Serial]], [[Component:_USB_Slave_(Comms)|USB Slave]], [[Component:_USB_HID_(Comms)|USB HID]]

Communicate over MIDI - [[Component:_MIDI_(Comms)|Midi Component]]

Communicate over a COM port - [[Component:_COM_Port_(Advanced)|COM Port Component]]

Communicate over a network - [[Component:_TCP_Base_(Comms)|TCPIP Base Component]]

Talk to existing third party hardware - [[Component:_K8055D_(Simulation)|Vellemann KS0108]], [[Component:_PS2000_(Simulation)|Pico Scope 2000 series]], [[Component:_MIAC_USB_Slave_(MIAC_Module)|MIAC USB Slave]]

==Adding your own DLL calls into Flowcode==

A DLL can easily be added to your program using the standard macro interface.

Start by placing the DLL file into a known location on your computer. A good place for stable DLL files is inside the "Flowcode v6/Components/DLL" folder or in the same folder as the Flowcode project file for portability.

[[File:DLLMacro.jpg]]

The syntax looks like this - (DLL Function Name) : (DLL Type) [(Path to DLL)]

Example:

'''ReadTime:DLLs[$(appdir)components/dll/DateTime.dll]'''

DLL Function name is the name of the function in the DLL you are trying to call, if the call cannot be found then the component debugger window will display the error.

DLL Type is the type of DLL, there is "DLLs" which is a standard type DLL and "DLLc" which is an alternative custom style DLL.

Path to DLL is the file path on your system, [$(appdir)components/dll/DLLNAME.dll] can be used for the Components/DLL directory [$(srcdir)DLLNAME.dll] can be used for the project directory.

If you don't already know the explicit DLL function names then they can be found by using a tool like [http://www.nirsoft.net/utils/dll_export_viewer.html DLL Export Viewer] to see inside the DLL file.

The DLL based macro appears like this in the [[Project_Explorer|Project explorer pane]].

[[File:DLLPane.jpg]]

The DLL based macro can then be called as part of your program just like any other macro or component macro.

The DLL call can even be wrapped up inside a component macro call as part of the component export process using the [[Interface_Manager#Interface_Manager|Interface manager]]. By specifying the macro as a simulation macro a user using your exported component can easily see that this is a macro that cannot be downloaded to an embedded target.

[[File:DLLFunc.jpg]]

==Creating your own DLLs==

You can create your own DLLs to suit your requirements by using free to use applications such as Microsoft Visual Studio.

A guide on creating a DLL in visual studio can be found here: [[Create a dll]] 
Or a more generic example (resulting DLL is not directly compatible): [http://msdn.microsoft.com/en-us/library/ms235636.aspx Walkthrough: Creating and Using a Dynamic Link Library (C++)]

Create a dll

2014-11-23T14:47:45Z

Kersing:

Flowcode 6 allows the use of DLLs in simulation. This page explains a possible way to create your own DLL for use with Flowcode.

==Requirements:==
To create a DLL a compiler is required. Microsoft provides [http://www.visualstudio.com/products/visual-studio-community-vs Visual Studio Community edition] for free (certain restrictions apply, see the FAQ on the page). The installer is relatively small, however it will download and install all required software which (depending on your internet connection) might take considerable time.

This walkthrough assumes the reader is familiar with the C language as the code for the DLL will be written in C.

==Create a DLL project==
All code and associated settings in Visual Studio are stored inside a project. As we are creating a DLL we need to appropriate project.

# From the ''FILE'' menu, select ''New''->''Project''.
# In the left pane, select ''Installed'', ''Templates'', ''Visual C++'', ''Win32''. In the right pane select ''Win32 Console Application''
# In the bottom pane enter the name for the application and a solution name. We will use 'DemoDLL' for the ''Name'' and 'DynamicLibraries' for the ''Solution Name''. [[File:Project-DLL.png|640px]]
# Choose the ''OK'' button to create the project. This opens the ''Win32 Application Wizard''. Choose the ''Next'' button on the first page of the wizard.
# On the ''Application Settings'' page, select ''DLL'' and choose the ''Finish'' button. [[File:Wizard-app.png|480px]]

==Add code to the project==
For this demonstration we will implement a few simple functions to show how various data types are passed between Flowcode and the DLL.

The functions are:
# unsigned char GetCounter() - Returns the current counter value (0-255) and increments it
# ResetCounter() - Resets the counter to zero
# bool GetCounterString(TCHAR *string, DWORD size) - Returns the current counter value as a string

First we create a new file with the definitions of the functions:
# In ''PROJECT'' choose menu item ''Add New Item''.
# In the left pane, select ''Installed'', ''Visual C++'', ''Code''. In the right pane select ''Header File (.h)''.
# At the bottom, enter a usefull ''Name''. We will use ''DemoDLLDefs.h'', next choose the ''Add'' button. [[File:Include-file.png|480px]]
# Add the following code to the file and save:

<code>
#ifdef DEMODLL_EXPORTS
#define DEMODLL_API __declspec(dllexport)
#else
#define DEMODLL_API __declspec(dllimport)
#endif

#ifdef __cplusplus
extern "C" {
#endif

DEMODLL_API unsigned char GetCounter();
DEMODLL_API void ResetCounter();
DEMODLL_API bool GetCounterString(TCHAR *str, DWORD size);

#ifdef __cplusplus
}
#endif
</code>

While creating the project Visual Studio automatically created a define for the symbol ''DEMODLL_EXPORTS''. In the definitions it is used to select the dllexport specification when compiling the DLL code. The ''extern "C"'' code is added to make sure the compiler generates code using the correct calling convention. (C uses plain names, C++ adds information to functions to allow for overloading)

Next a couple of project options need to be set:
# Select ''DemoDLL Properties'' in the ''PROJECT'' menu.
# In the ''Configuration'' drop down select ''All Configurations''
# Set the ''Character Set'' to ''Not Set''
## In the left pane select ''Configuration Properties'', ''General''
## Select the drop down to the right of ''Character Set'', select ''Not Set''.
## Choose the ''Apply'' button [[File:Options-charset.png|480px]]
# Allow use of less secure string manipulation functions:
## In the left pane select ''Configuration Properties'', ''C/C++'', ''Preprocessor''.
## Modify the ''Preprocessor Definitions'', include ''_CRT_SECURE_NO_WARNINGS;'' between ''WIN32;'' and ''<different options>''.
## Click outside the definitions line and choose the ''OK'' button. [[File:Options-preprocessor.png|480px]]

Finally we implement the functions.
# Open the ''DemoDLL.cpp'' tab.
# Add the following code and save:
<code>
#include "stdafx.h"
#include "DemoDLLDefs.h"
#include <tchar.h>
#include <stdio.h>

#ifdef __cplusplus
extern "C" {
#endif

static unsigned char counter = 0;

unsigned char GetCounter()
{
return counter++;
}

void ResetCounter()
{
counter = 0;
}

bool GetCounterString(TCHAR *str, DWORD size)
{
DWORD required = 0;
TCHAR buffer[40];

_stprintf(buffer, "%d", counter);

required = _tcslen(buffer);
if (IsBadWritePtr(str, required))
{
SetLastError(ERROR_INSUFFICIENT_BUFFER);
return FALSE;
}

_tcsncpy(str, buffer,size - 1);
return TRUE;
}

#ifdef __cplusplus
}
#endif
</code>

==Compilation & Installation ==
The everything required has now been created. The next step is to compile the code:
# At the top of the screen, just below the menu bar there is a drop down ''Debug''. Select the down arrow and choose ''Release''.
# In the ''BUILD'' menu choose ''Build Solution''.
# After successful compilation the output window at the bottom of the screen should list something like ''DemoDLL.vcxproj -> C:\Users\kersing\Documents\Visual Studio 2013\Projects\DynamicLibraries\Release\DemoDLL.dll''.
# Browse to the directory listed in the output window and copy the file ''DemoDLL.dll'' to the ''Components\dll' folder of your Flowcode installation. (Usually ''C:\Program Files (x86)\Flowcode 6\Components\dll'')

==Test==
Use [[media:Demo.fcfx|Demo.fcfx]] to test your newly created DLL. Output will appear in the ''Component Debugger'' window (open from the ''View'' menu if not already open).

File:Options-charset.png

2014-11-23T14:39:23Z

Kersing:

File:Options-preprocessor.png

2014-11-23T14:39:23Z

Kersing:

File:Demo.fcfx

2014-11-23T14:39:23Z

Kersing:

Create a dll

2014-11-23T14:36:34Z

Kersing:

==!!This page is a work in progress!!==

Flowcode 6 allows the use of DLLs in simulation. This page explains a possible way to create your own DLL for use with Flowcode.

==Requirements:==
To create a DLL a compiler is required. Microsoft provides [http://www.visualstudio.com/products/visual-studio-community-vs Visual Studio Community edition] for free (certain restrictions apply, see the FAQ on the page). The installer is relatively small, however it will download and install all required software which (depending on your internet connection) might take considerable time.

This walkthrough assumes the reader is familiar with the C language as the code for the DLL will be written in C.

==Create a DLL project==
All code and associated settings in Visual Studio are stored inside a project. As we are creating a DLL we need to appropriate project.

# From the ''FILE'' menu, select ''New''->''Project''.
# In the left pane, select ''Installed'', ''Templates'', ''Visual C++'', ''Win32''. In the right pane select ''Win32 Console Application''
# In the bottom pane enter the name for the application and a solution name. We will use 'DemoDLL' for the ''Name'' and 'DynamicLibraries' for the ''Solution Name''. [[File:Project-DLL.png|640px]]
# Choose the ''OK'' button to create the project. This opens the ''Win32 Application Wizard''. Choose the ''Next'' button on the first page of the wizard.
# On the ''Application Settings'' page, select ''DLL'' and choose the ''Finish'' button. [[File:Wizard-app.png|480px]]

==Add code to the project==
For this demonstration we will implement a few simple functions to show how various data types are passed between Flowcode and the DLL.

The functions are:
# unsigned char GetCounter() - Returns the current counter value (0-255) and increments it
# ResetCounter() - Resets the counter to zero
# bool GetCounterString(TCHAR *string, DWORD size) - Returns the current counter value as a string

First we create a new file with the definitions of the functions:
# In ''PROJECT'' choose menu item ''Add New Item''.
# In the left pane, select ''Installed'', ''Visual C++'', ''Code''. In the right pane select ''Header File (.h)''.
# At the bottom, enter a usefull ''Name''. We will use ''DemoDLLDefs.h'', next choose the ''Add'' button. [[File:Include-file.png|480px]]
# Add the following code to the file and save:

<code>
#ifdef DEMODLL_EXPORTS
#define DEMODLL_API __declspec(dllexport)
#else
#define DEMODLL_API __declspec(dllimport)
#endif

#ifdef __cplusplus
extern "C" {
#endif

DEMODLL_API unsigned char GetCounter();
DEMODLL_API void ResetCounter();
DEMODLL_API bool GetCounterString(TCHAR *str, DWORD size);

#ifdef __cplusplus
}
#endif
</code>

While creating the project Visual Studio automatically created a define for the symbol ''DEMODLL_EXPORTS''. In the definitions it is used to select the dllexport specification when compiling the DLL code. The ''extern "C"'' code is added to make sure the compiler generates code using the correct calling convention. (C uses plain names, C++ adds information to functions to allow for overloading)

Next a couple of project options need to be set:
# Select ''DemoDLL Properties'' in the ''PROJECT'' menu.
# In the ''Configuration'' drop down select ''All Configurations''
# Set the ''Character Set'' to ''Not Set''
## In the left pane select ''Configuration Properties'', ''General''
## Select the drop down to the right of ''Character Set'', select ''Not Set''.
## Choose the ''Apply'' button
# Allow use of less secure string manipulation functions:
## In the left pane select ''Configuration Properties'', ''C/C++'', ''Preprocessor''.
## Modify the ''Preprocessor Definitions'', include ''_CRT_SECURE_NO_WARNINGS;'' between ''WIN32;'' and ''<different options>''.
## Click outside the definitions line and choose the ''OK'' button.

Finally we implement the functions.
# Open the ''DemoDLL.cpp'' tab.
# Add the following code and save:
<code>
#include "stdafx.h"
#include "DemoDLLDefs.h"
#include <tchar.h>
#include <stdio.h>

#ifdef __cplusplus
extern "C" {
#endif

static unsigned char counter = 0;

unsigned char GetCounter()
{
return counter++;
}

void ResetCounter()
{
counter = 0;
}

bool GetCounterString(TCHAR *str, DWORD size)
{
DWORD required = 0;
TCHAR buffer[40];

_stprintf(buffer, "%d", counter);

required = _tcslen(buffer);
if (IsBadWritePtr(str, required))
{
SetLastError(ERROR_INSUFFICIENT_BUFFER);
return FALSE;
}

_tcsncpy(str, buffer,size - 1);
return TRUE;
}

#ifdef __cplusplus
}
#endif
</code>

==Compilation & Installation ==
The everything required has now been created. The next step is to compile the code:
# At the top of the screen, just below the menu bar there is a drop down ''Debug''. Select the down arrow and choose ''Release''.
# In the ''BUILD'' menu choose ''Build Solution''.
# After successful compilation the output window at the bottom of the screen should list something like ''DemoDLL.vcxproj -> C:\Users\kersing\Documents\Visual Studio 2013\Projects\DynamicLibraries\Release\DemoDLL.dll''.
# Browse to the directory listed in the output window and copy the file ''DemoDLL.dll'' to the ''Components\dll' folder of your Flowcode installation. (Usually ''C:\Program Files (x86)\Flowcode 6\Components\dll'')

File:Include-file.png

2014-11-23T14:26:15Z

Kersing:

File:Wizard-app.png

2014-11-23T14:26:14Z

Kersing:

File:Project-DLL.png

2014-11-23T14:25:18Z

Kersing:

Create a dll

2014-11-23T14:10:40Z

Kersing:

==!!This page is a work in progress!!==

Flowcode 6 allows the use of DLLs in simulation. This page explains a possible way to create your own DLL for use with Flowcode.

==Requirements:==
To create a DLL a compiler is required. Microsoft provides [http://www.visualstudio.com/products/visual-studio-community-vs Visual Studio Community edition] for free (certain restrictions apply, see the FAQ on the page). The installer is relatively small, however it will download and install all required software which (depending on your internet connection) might take considerable time.

This walkthrough assumes the reader is familiar with the C language as the code for the DLL will be written in C.

==Create a DLL project==
All code and associated settings in Visual Studio are stored inside a project. As we are creating a DLL we need to appropriate project.

# From the ''FILE'' menu, select ''New''->''Project''.
# In the left pane, select ''Installed'', ''Templates'', ''Visual C++'', ''Win32''. In the right pane select ''Win32 Console Application''
# In the bottom pane enter the name for the application and a solution name. We will use 'DemoDLL' for the ''Name'' and 'DynamicLibraries' for the ''Solution Name''.
# Choose the ''OK'' button to create the project. This opens the ''Win32 Application Wizard''. Choose the ''Next'' button on the first page of the wizard.
# On the ''Application Settings'' page, select ''DLL'' and choose the ''Finish'' button.

==Add code to the project==
For this demonstration we will implement a few simple functions to show how various data types are passed between Flowcode and the DLL.

The functions are:
# unsigned char GetCounter() - Returns the current counter value (0-255) and increments it
# ResetCounter() - Resets the counter to zero
# bool GetCounterString(TCHAR *string, DWORD size) - Returns the current counter value as a string

First we create a new file with the definitions of the functions:
# In ''PROJECT'' choose menu item ''Add New Item''.
# In the left pane, select ''Installed'', ''Visual C++'', ''Code''. In the right pane select ''Header File (.h)''.
# At the bottom, enter a usefull ''Name''. We will use ''DemoDLLDefs.h'', next choose the ''Add'' button.
# Add the following code to the file and save:

<code>
#ifdef DEMODLL_EXPORTS
#define DEMODLL_API __declspec(dllexport)
#else
#define DEMODLL_API __declspec(dllimport)
#endif

#ifdef __cplusplus
extern "C" {
#endif

DEMODLL_API unsigned char GetCounter();
DEMODLL_API void ResetCounter();
DEMODLL_API bool GetCounterString(TCHAR *str, DWORD size);

#ifdef __cplusplus
}
#endif
</code>

While creating the project Visual Studio automatically created a define for the symbol ''DEMODLL_EXPORTS''. In the definitions it is used to select the dllexport specification when compiling the DLL code. The ''extern "C"'' code is added to make sure the compiler generates code using the correct calling convention. (C uses plain names, C++ adds information to functions to allow for overloading)

Next a couple of project options need to be set:
# Select ''DemoDLL Properties'' in the ''PROJECT'' menu.
# In the ''Configuration'' drop down select ''All Configurations''
# Set the ''Character Set'' to ''Not Set''
## In the left pane select ''Configuration Properties'', ''General''
## Select the drop down to the right of ''Character Set'', select ''Not Set''.
## Choose the ''Apply'' button
# Allow use of less secure string manipulation functions:
## In the left pane select ''Configuration Properties'', ''C/C++'', ''Preprocessor''.
## Modify the ''Preprocessor Definitions'', include ''_CRT_SECURE_NO_WARNINGS;'' between ''WIN32;'' and ''<different options>''.
## Click outside the definitions line and choose the ''OK'' button.

Finally we implement the functions.
# Open the ''DemoDLL.cpp'' tab.
# Add the following code and save:
<code>
#include "stdafx.h"
#include "DemoDLLDefs.h"
#include <tchar.h>
#include <stdio.h>

#ifdef __cplusplus
extern "C" {
#endif

static unsigned char counter = 0;

unsigned char GetCounter()
{
return counter++;
}

void ResetCounter()
{
counter = 0;
}

bool GetCounterString(TCHAR *str, DWORD size)
{
DWORD required = 0;
TCHAR buffer[40];

_stprintf(buffer, "%d", counter);

required = _tcslen(buffer);
if (IsBadWritePtr(str, required))
{
SetLastError(ERROR_INSUFFICIENT_BUFFER);
return FALSE;
}

_tcsncpy(str, buffer,size - 1);
return TRUE;
}

#ifdef __cplusplus
}
#endif
</code>

==Compilation & Installation ==
The everything required has now been created. The next step is to compile the code:
# At the top of the screen, just below the menu bar there is a drop down ''Debug''. Select the down arrow and choose ''Release''.
# In the ''BUILD'' menu choose ''Build Solution''.
# After successful compilation the output window at the bottom of the screen should list something like ''DemoDLL.vcxproj -> C:\Users\kersing\Documents\Visual Studio 2013\Projects\DynamicLibraries\Release\DemoDLL.dll''.
# Browse to the directory listed in the output window and copy the file ''DemoDLL.dll'' to the ''Components\dll' folder of your Flowcode installation. (Usually ''C:\Program Files (x86)\Flowcode 6\Components\dll'')

Create a dll

2014-11-23T11:55:08Z

Kersing: Created page with "==!!This page is a work in progress!!== Flowcode 6 allows the use of DLLs in simulation. This page explains a possible way to create your own DLL for use with Flowcode. ==Re..."

Sidebar: Flowcode Help Overview:ComponentCreation

2014-09-20T10:28:18Z

Kersing:

Help:Component Creation

2014-09-20T10:27:20Z

Kersing: Kersing moved page Component Creation to Help:Component Creation

== Component Creation ==

Starting with Flowcode 6, users can easily create new components. A new component is basically a Flowcode program, with macros to implement the functionality required for the component. Flowcode 6 components can include simulation as well. Simulation is implemented using macros as well.

A typical component will include at least an initialization macro and a graphic element to represent the component on a panel.

New components can be build from scratch or build on existing components.

The [[Exercises]] page contains examples on component creation at the bottom of the page.

Component Creation

2014-09-20T10:27:20Z

Kersing: Kersing moved page Component Creation to Help:Component Creation

#REDIRECT [[Help:Component Creation]]

Help:Component Creation

2014-09-20T10:25:14Z

Kersing: Kersing moved page Help:Contents to Component Creation: Option to create the page created it in the wrong section.

Help:Contents

2014-09-20T10:25:14Z

Kersing: Kersing moved page Help:Contents to Component Creation: Option to create the page created it in the wrong section.

#REDIRECT [[Component Creation]]

Help:Component Creation

2014-09-20T10:19:49Z

Kersing: Created page with "== Component Creation == Starting with Flowcode 6, users can easily create new components. A new component is basically a Flowcode program, with macros to implement the funct..."

C Code Icon Properties

2014-05-18T18:21:30Z

Kersing:

<sidebar>Sidebar: Icon Properties</sidebar>
{| style="margin:auto; text-align:center;"
|-
|[[File:Btn_C_Code.gif|border]]
| width="50px" |→
|[[File:Gen_C_Code_Flowchart_Icon.png]]
|width="50px" |→
|[[File:Gen_C_Code_Icon_Properties.png]]
|}

Flowcode is designed to allow those new to microcontroller programming to design programs with little knowledge of other programming languages. However it is possible to embed code written in other languages into Flowcode programs. Programs written in C and Assembly code can be embedded in Flowcode using the Code icon. This means that it is possible to take complex programs (you will find lots of programs on the internet) written in C or assembly and embed them into your designs.

The code can not be simulated by Flowcode, but is passed on to the microcontroller during compilation.

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Variable Box'''

Quickly browse the variables defined in your project. You can reference ports directly or select from a list of available Global or Local variables. Dragging and dropping the variables into the C Code box will automatically add the correct Flowcode specific prefix.

'''C Code'''

Enter any C code you wish to include in the flowchart. The C code is not checked by Flowcode but is passed straight to the C compiler when the flowchart is compiled. It is important to verify that the C code entered is correct, as syntax errors will cause the compilation of the whole flowchart to fail.

To access Flowcode variables, macro functions and connection points, it is necessary to color the variable in your C code with the prefixes FCV_, FCM_ and FCC_MacroName_ respectively.

For example, to use a Flowcode variable called DELAY in your C code, you must refer to it using FCV_DELAY

Note that all Flowcode defined variables are upper case.

To call a Flowcode macro called TEST in your C code, you must call FCM_TEST();

Note that for Flowcode versions up to Flowcode 6, all Flowcode macro names are upper case.

To jump to a connection point called A, defined in a Flowcode macro called TEST, the users C code must be goto FCC_TEST_A;. Connection points defined in the main flowchart of a Flowcode file are prefixed FCC_Main_.

'''Assembly Code'''

Assembly code can be added into the code field in a C assembly code wrapper.

For a single line of code use the asm operator in front of each instruction, e.g.

asm movlw 5

or enclose several statements within an asm block:

asmTo access Flowcode variables, macro functions and connection points, it is necessary to further color the prefixes used above with a preceding underscore, _FCV_, _FCM_ and _FCC_MacroName_ respectively.

The examples used above now become _FCV_DELAY, _FCM_TEST() and _FCC_TEST_A.

====Video instructions====

See the [http://www.youtube.com/watch?v=JgjQlV6LQYI&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Custom code] video to learn how to add custom C code to the flowchart using the C Code icon to set the value of a variable to 0.

<div align="center">
{{#ev:youtube|JgjQlV6LQYI|640}}
</div>

Decision Icon Properties

2013-11-15T13:06:07Z

Kersing:

<sidebar>Sidebar: Icon Properties</sidebar>
{| style="margin:auto; text-align:center;"
|-
|[[File:Btn_Decision.gif|border]]
| width="50px" |→
|[[File:Gen_Decision_Flowchart_Icon.png]]
|width="50px" |→
|[[File:Gen_Decision_Icon_Properties.png]]
|}

Decision icons allow you to test a condition and redirect the flow according to the outcome.
Icons can be placed in either branch from the decision icon.

'''Display Name'''

The name of the icon that appears on the flowchart.

'''Condition'''

The decision box tests this condition to see which branch to continue down. If the condition evaluates to 0 or false then the 'No' branch is chosen. If the condition evaluates to a non zero number or true then the 'Yes' branch is chosen. Conditions can be made up from numbers, variables and operators:

See [[Calculation Icon Properties]] for a list of valid operators.

Numeric values can be in decimal (unmarked) or in HEX format (preceded by 0x) or in Binary format (preceded by 0b) e.g. 255 or 0xFF or 0b01010101.

Assuming that the variables have been previously defined, all the following are valid conditions.

DELAY = DELAY + 1

DELAY = (MYVAR + 3) * 3

NEXTBIT = LASTBIT >> 2 & MASK

AANDB = PORT_A AND PORT_B

INVX = NOT X

To test for two or more conditions, write tests for the individual conditions and combine them with logical operators.

When both conditions must be true: condition1 && condition2

When one condition being true suffices: condition1 || condition2

Assuming that the variables have been previously defined, all the following are valid conditions.

(DELAY = 1) && (X = 0)

(DELAY = 1) || (DELAY = 4)

(DELAY = 1) || ( (DELAY = 3) && (X = 0) )

'''Variables Arrow'''

Clicking on the down arrow brings up the variables dialog window allowing you to select an existing variable or to [[Creating Variables|create a new one]].

'''Swap Yes and No'''

Normally the 'Yes' path of execution goes off to the right of the decision icon and the 'No' path carries on down the flowchart. Select this option to swap the two branches around.

'''Boolean values'''

Flowcode treats zero as false and any non-zero value as true.

This allows the use of variables in a true or false context.

For example 'If TIMEUP' would execute the 'Yes' path if TIMEUP was non-zero.

====Video instructions====

See the [http://www.youtube.com/watch?v=iLT7rwsSL88&list=PLQDWBb7bxuCgg6aJgPJcfXBMzZdLILceQ Decision] video to learn how to use the Decision icon effectively with other icons such as [[Input Icon Properties|Input]], [[Output Icon Properties|Output]] and [[Delay Icon Properties|Delay]] icons.

<div align="center">
{{#ev:youtube|iLT7rwsSL88|640}}
</div>