emDrive User Manual

• Scripting
• Parameters
• Access Level
• Lua Manual
• Throttle Application Manual

Scripting

This page will describe how to use the scripting feature. To use the feature emDrive Configurator needs to have an open connection with an emDrive device. Scripts are written in C# (.cs files). To open the Script Window navigate to the menu bar, Device > Script.

User interface

The Browse button will open a File Open window to choose the script file. Once a file is loaded the file path will be displayed in the textbox next to it.

The Run script button will start the execution of the script.

Stop will stop the execution of the script.

The Script has infinite loop checkbox is used for scripts with long-running loops. This will automatically get set when the file is loaded if it contains the Cancellation Token implementation.

Scripts can be added to Shortcuts by selecting the desired shortcut in the Set script to shortcut button drop-down menu and clicking the Set button.

Long-running scripts cannot be used with Shortcuts.

The window also comes with a simple script editor that can be opened with the Edit script.

Below these controls is the Command Overview section which will be populated when certain API calls are made.

To the right of it is the Log section which will print text if the Logging API calls are made.

Creating a script file

Script files are written in C#. Create a .cs file in your desired text editor or download one of the templates provided in the attachments.

Every script needs the using System; and using emDrive_Configurator; using statements as well as a public class Script with the public void Main() method.

Version 2.5.4.0 and lower use using eDrive_Configurator; instead of using emDrive_Configurator;.

If long-running or infinite loops are used the user must add using System.Threading; and change the main method to public void Main(CancellationToken).

This is available only from version 2.9.0.0 and onwards. Long-running scripts should not be used in versions below 2.9.0.0.

Basic template

The basic template is used for simple scripts that don't contain long-running loops.

/*
  Author:       Amadej Arnus
  Date:         2024-05-08
*/

using System;
using emDrive_Configurator;

public class Script
{
    public void Main()
    {
        // Your code goes here
    }
}

Long-running template

This template is used for scripts that are expected to contain long-running or infinite loops. This allows the user to click Stop in the Script Window which will cancel the cancellation token and exit the script execution. The user must check for CancellationToken.IsCancellationRequested value in their loops for this to work.

/*
  Author:       Amadej Arnus
  Date:         2024-05-98
*/

using System;
using emDrive_Configurator;

using System.Threading;

public class Script
{
    public void Main(CancellationToken cancellationToken)
    {
        // Your code goes here

        // Example of loop with cancellation token
        while (true)
        {
            // Your code goes here

            if (cancellationToken.IsCancellationRequested)
            {
                break;
            }
        }
    }
}

Scripting API

The following section will list and describe all of the available API calls.

Script - Watch Interoperability

This functionality is only available for emDrive Configurator 2.13.0.0 and later.

These API calls allow the user to add virtual script objects to Watch and write to them, as well as request the last value read for a specific object already in Watch. This can be achieved by using the WatchScriptObject class or the method calls described below.

WatchScriptObject class

The WatchScriptObject class uses the API calls described below but is a more user-friendly approach to this functionality. Unless specified the index and subindex properties will be set automatically. index will always be 0xFFFF and subindex will increment from 0 onwards. If the user wishes to reset the subindex counter they must call the ResetSubIndexCounter method.

The TryToAddToWatch method will attempt to add the virtual object to Watch. See TryAddScriptEntryToWatch method for possible errors.

The TryToAddValueToWatch method will attempt to add the value to the already created virtual object in Watch. See TryAddScriptEntryValue method for possible errors.

public class WatchScriptObject
{
    // Properties
    public string Name { get; }
    public int NodeId { get; } // Default: 0
    public uint Index { get; } // Default: 0xFFFF
    public ushort SubIndex { get; }
    public ushort DataType { get; }
  
    // Constructors
    public WatchScriptObject(string name, ushort datatype);
    public WatchScriptObject(string name, ushort subindex, ushort datatype);
    public WatchScriptObject(string name, uint index, ushort subindex, ushort datatype);

    // Methods
    public bool TryToAddToWatch();
    public bool TryToAddValueToWatch(dynamic value);
    public static void ResetSubIndexCounter();
}

TryAddScriptEntryToWatch method

Attempts to create a new script virtual object in Watch with the specified name, nodeId, index, subindex, and datatype. Returns true if successful or false if failed.

public static bool TryAddScriptEntryToWatch(string name, int nodeId, uint index, ushort subindex, ushort datatype)

Fail reasons:

• Object with specified nodeId, index and subindex already exists in Watch.
  

TryAddScriptEntryValue method

Attempts to write value to the script virtual object in Watch. Returns true if successful or false if failed.

public static bool TryAddScriptEntryValue(int nodeId, uint index, ushort subindex, dynamic value)

Fail reasons:

• Object with specified nodeId, index and subindex does not exist in Watch.
• Failed to convert value to the declared datatype.

TryGetLastWatchValue method

Attempts to get the last read value of the object specified with nodeId, index, subindex and saves it to value. Returns true if successful or false if failed.

public static bool TryGetWatchValue(int nodeId, uint index, ushort subindex, out double value)

Fail reasons:

• Object with specified nodeId, index and subindex does not exist in Watch.
• Failed to convert object value to type double.

Example file

/*
  Author:       Amadej Arnus
  Date:         2024-04-23
*/

using System;
using System.Windows.Forms;
using emDrive_Configurator;
using System.Threading;
using Timer = System.Threading.Timer;

using System.Collections.Generic;
using System.Diagnostics;
using System.Drawing;
using System.Globalization;
using System.IO;
using System.IO.Ports;
using System.Linq;
using System.Management;
using System.Text;
using System.Text.RegularExpressions;

public class Script
{
    // Prepare error string
    string err = string.Empty;

    // Create object that we will attempt to read from watch
    CO_Object HwMonitorUdc = new CO_Object(0x3071, 0x00);

    public void Main(CancellationToken cancellationToken)
    {
        // This will run the example for the WatchScriptObject
        ObjectBasedVersion(cancellationToken);

        // This will run the example for the API calls
        //ObjectBasedVersion(cancellationToken);
    }

    private void ObjectBasedVersion(CancellationToken cancellationToken)
    {
        // Create new objects for watch-script interoperability
        Procedure.WatchScriptObject intObject = new Procedure.WatchScriptObject("ScriptObject_Int32", 0x0004);
        Procedure.WatchScriptObject floatObject = new Procedure.WatchScriptObject("ScriptObject_Real32", 0x0008);

        // Add int object to watch
        if (intObject.TryToAddToWatch())
        {
            LogResult("ScriptObject_Int32 added to watch");
        }
        else
        {
            LogResult("ScriptObject_Int32 not added to watch");
        }

        // Add float object to watch
        if (floatObject.TryToAddToWatch())
        {
            LogResult("ScriptObject_Real32 added to watch");
        }
        else
        {
            LogResult("ScriptObject_Real32 not added to watch");
        }

        int i = 0;

        // Do the loop until cancellationToken is requested
        while (!cancellationToken.IsCancellationRequested)
        {
            double hwMonitorValue = 0;

            // Read last value of HwMonitorUdc object
            if (HwMonitorUdc.TryGetWatchValue(1, out hwMonitorValue))
            {
                i++;

                // Set new value to int and float objects
                if (!intObject.TryToAddValueToWatch(i))
                {
                    LogResult("Failed to write value to ScriptObject_Int32");
                }

                if (!floatObject.TryToAddValueToWatch(hwMonitorValue * 1.5))
                {
                    LogResult("Failed to write value to ScriptObject_Real32");
                }
            }
            // If not successful, log the error
            else
            {
                LogResult("Failed to get HwMonitorUdc value");
            }

            Procedure.Delay(200);
        }
    }

    private void ApiBasedVersion(CancellationToken cancellationToken)
    {
        // Add int object to watch
        if (TryAddScriptEntryToWatch("ScriptObject_Int32", 1, 0xFFFF, 0x01, datatype: 0x0004))
        {
            LogResult("ScriptObject_Int32 added to watch");
        }
        else
        {
            LogResult("ScriptObject_Int32 not added to watch");
        }

        // Add float object to watch
        if (TryAddScriptEntryToWatch("ScriptObject_Real32", 1, 0xFFFF, 0x02, datatype: 0x0008))
        {
            LogResult("ScriptObject_Real32 added to watch");
        }
        else
        {
            LogResult("ScriptObject_Real32 not added to watch");
        }

        int i = 0;

        // Do the loop until cancellationToken is requested
        while (!cancellationToken.IsCancellationRequested)
        {
            double hwMinutorValue = 0;

            // Read last value of HwMonitorUdc object
            if (TryGetWatchValue(1, 0x3071, 0x00, out hwMinutorValue))
            {
                i++;

                // Set new value to int and float objects
                if (!TryAddScriptEntryValue(1, 0xFFFF, 0x01, i))
                {
                    LogResult("Failed to write value to ScriptObject_Int32");
                }

                if (!TryAddScriptEntryValue(1, 0xFFFF, 0x02, hwMinutorValue * 1.5))
                {
                    LogResult("Failed to write value to ScriptObject_Real32");
                }
            }
            // If not successful, log the error
            else
            {
                LogResult("Failed to get HwMonitorUdc value");
            }

            Procedure.Delay(200);
        }
    }

    // The following methods are just wrappers to shorten the method calls
    bool TryAddScriptEntryToWatch(string name, int nodeId, uint index, ushort subindex, ushort datatype)
    {
        return Procedure.TryAddScriptEntryToWatch(name, nodeId, index, subindex, datatype);
    }
    bool TryAddScriptEntryValue(int nodeId, uint index, ushort subindex, dynamic value)
    {
        return Procedure.TryAddScriptEntryValue(nodeId, index, subindex, value);
    }
    bool TryGetWatchValue(int nodeId, uint index, ushort subindex, out double value)
    {
        return Procedure.TryGetWatchValue(nodeId, index, subindex, out value);
    }

    void LogResult(string LogString)
    {
        LogString = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss") + ": " + LogString;
        Procedure.Log(LogString);
    }
}

// CO_Object for readability
class CO_Object
{
    public uint index;
    public ushort subindex;
    public dynamic value;

    public CO_Object(uint index, ushort subindex)
    {
        this.index = index;
        this.subindex = subindex;
    }

    public bool TryGetWatchValue(int nodeId, out double value)
    {
        return Procedure.TryGetWatchValue(nodeId, index, subindex, out value);
    }
}

Script Features

Script features are extensions to the scripting functionality.

In order to use script features, the user must add 

using emDrive_Configurator.Scripts.Features;

Modbus TCP

This functionality is only available for emDrive Configurator 2.13.1.0 and later.

ModbusTCP currently supports connection with Modbus Servers (Client Mode) through TCP. In order to connect to the device, you need to provide the IP Address, Port and Modbus Server ID (Bus Address).

In the following Example, the IP is 127.0.0.1, the Port is 502 and the Modbus Server ID is 1:

ModbusTCP ModbusDevice1 = new ModbusTCP("127.0.0.1", 502, 1);

Alternatively, the device endianness can also be specified in the connection constructor:

ModbusTCP ModbusLocalhost = new ModbusTCP("127.0.0.1", 502, 1, ModbusEndianness.LittleEndian);

Default Endianness is set to Big Endian.

Currently Read and Write Holding registers operation is supported using generic functions:

short i16_var = 0;

// Read Holding Register at Address 100
if(ModbusLocalhost.ReadHoldingRegister<short>(100, out i16_var) == true)
{
  // Read Successful
}
else
{
  // Read Failed
}

// Write Holding Register at Address 100
ModbusLocalhost.WriteHoldingRegister(100, i16_var);    

Parameters

Object's Attributes

Each CANopen Object in emDrive inverter has several attributes. Following attributes are related to changing, storing and loading values of objects.

Object which have Persistent attribute set to "1" are stored in permanent memory and are therefore called "Parameters".

Objects attributes are visible in EDS or DCF files.

See Access Levels for more information about access to objects.

Parameters Sections

There are several different "sections" where parameters can be saved or restored from.

Current Parameter Values

Current value of parameter that is in use. This values are used by applications, firmware and can be access and changed via CANopen or custom CAN messages, depending on inverter.

Manufacturer Default Values

This values are hardcoded into firmware and are used to restore the device to factory default configuration. See section "Restore Manufacturer defaults - "Factory Reset" (5)"

Customer Default Values

Customer defaults is special section that can be used by Emsiso customer during their configuration or alternatively can be loaded at production. Customer has than the ability to reset configuration to their desired defaults i.e. "Customer defaults" without completely resetting parameters to factory defaults.

See sections "Saving to Customer defaults (3)" and "Restore Customer defaults (4)" on how to store values and restore values from this section. 

Device Parameter Values

Parameter values stored into permanent memory that are loaded at every power up. See section "Saving Device parameters (1)" on how to save current configuration.

There is also addition section "Calibration parameter" which is used for calibration in production. Customer does not have access to it. Objects that are stored in that section will be loaded from that section at powerup.

Saving and Restoring Parameters

Saving Device parameters (1)

Saving parameters is done by SDO write to CANopen object with index 0x1010 - "Store_Parameters_Field". Writing value 0x73617665 (ASCII "save") or byte swapped value 0x65766173 to any of sub indexes 0x01-0x04. Return status of SDO write will indicate success of failure.

Saving can also be done within emDrive Configurator by selecting "Device" -> "Save parameters" or by using shortcut "CTRL + S".

Saving parameters in emDrive Configurator

Saving to Customer defaults (3)

Saving parameters to "Customer Defaults" section is done by SDO write to CANopen object with index 0x1010 - "Store_Parameters_Field". Writing value 0x73617665 (ASCII "save") or byte swapped value 0x65766173 to sub index 0x05 "Save_Customer_Defined_Parameters. Return status of SDO write will indicate success of failure.

Saving can also be done within emDrive Configurator by selecting "Device" -> "Save to customer parameters" or by using shortcut "CTRL + SHIFT + S".

Saving parameters to Customer defaults in emDrive Configurator

Saving to Customer defaults is only possible with Access Level 2 (Customer) or above.

Restore Manufacturer defaults - "Factory Reset" (5)

Restoring parameter values to manufacturer defaults is done by SDO write to CANopen object with index 0x1011 - "Restore_Default_Parameters". Writing value 0x6C6F6164 (ASCII "load") or byte swapped value 0x64616F6C to any of sub index 0x01-0x04. Return status of SDO write will indicate success of failure.

Restoring can also be done within emDrive Configurator by selecting "Device" -> "Set parameters to manufacturer defaults" or by using shortcut "CTRL + D".

Setting parameters to manufacturer defaults in emDrive Configurator

Restoring from manufacturer defaults is only possible with Access Level 2 (Customer) or above.

Restore Customer defaults (4)

Restoring parameter values to Customer defaults is done by SDO write to CANopen object with index 0x1011 - "Restore_Default_Parameters". Writing value 0x6C6F6164 (ASCII "load") or byte swapped value 0x64616F6C to sub index 0x05 "Restore_Cusstomer_Define_Default_Parameters. Return status of SDO write will indicate success of failure.

Restoring to Customer defaults can also be done within emDrive Configurator by selecting "Device" -> "Set parameters to customer defaults" or by using shortcut "CTRL + SHIFT + D".

Restoring parameters from Customer defaults in emDrive Configurator

After each operation device shall be reset to apply new values.

Access Level

Access Level functionality is different depending on the emDRIVE firmware version.

Lua Manual

Disclaimer
The EMSISO d.o.o. scripting functionality, based on the Lua programming language, is provided to enable flexibility and customization for motor control applications. However, EMSISO d.o.o. assumes no responsibility or liability for any damages, malfunctions, injuries, or losses resulting from the use of scripts provided by EMSISO d.o.o. or scripts created, modified, or executed by users.
Users are fully responsible for testing and verifying all scripts in a controlled and safe environment before deployment. Any script used in conjunction with EMSISO d.o.o. products is done at the user’s own risk.
By using the scripting feature, you acknowledge and agree to release EMSISO d.o.o. from all claims, demands, or liability for any incidents that may arise from its use.

1. General

1.1 Purpose

• This manual helps you create and run Lua scripts on emDrive.
• It also informs you about any warnings and known issues.

1.2 Scope

• The manual covers Lua scripting features, including how to:
  • Download scripts
  • Control scripts
  • Debug scripts
  • Use functions provided by the emDrive library
• It also lists known issues and limitations of the scripting functionality.

1.3 Important Note

• This manual assumes you already know Lua and emDrive Configurator software.
• It is valid for Lua version 5.4. For more details on Lua, visit:
  • Lua 5.4 Manual
  • Programming in Lua

2. emDrive library

2.1 General

The emDrive library is used instead of the standard Lua libraries. This library includes some functions that are identical to those in the standard Lua library, some that have been modified, and others that are unique to emDrive.

Do not overwrite the emDrive library functions and variables.

The emDrive library is organized into different sets, each focused on a specific group of functionalities. This section will describe these sets and their functions and variables in detail.

Here is an example of how to use a library function. This example will show a legend that explains how to read the prototypes of library functions. Words in blue represent variable types, such as arguments or return values. These types follow standard Lua conventions, with the addition of the "integer" type, which represents whole numbers.

When your script calls a function from the emDrive library, the arguments you provide must match the prototype exactly, including the type and, for tables, their structure. If they do not, an error will occur.

number | nil ret1, boolean ret2 = Namespace.FunctionName({integer arg1Field1, string arg1Field2} arg1, 
{integer, integer, integer [5:5-11], integer [13]} arg2, [, string arg3], arg4…)

This is an example of a function named Namespace.FunctionName. It takes in: 2 fixed arguments, 1 optional 
argument and a variable number of arguments. It also returns 2 values where the first can also be nil.

Functions can be called with more arguments then expected in which case excess arguments are ignored.

The emDrive library can raise errors in addition to those raised by the Lua kernel, such as accessing nil values. These library errors usually occur when the type or value of an argument does not match what is expected.

For each function in the emDrive library, the possible errors (exceptions) and the conditions that cause them will be listed.

2.2 Functions

2.2.1 Base

This library provides base script functionality that is not specific to any part of the emDrive hardware (HW) or firmware (FW).

Error(string message [, integer level])

The Error function raises an error with a custom message and specifies the level of the error position. It is useful for throwing exceptions, such as for debugging purposes. This function is equivalent to the standard error() function in Lua and never returns.

2.2.2 I/O

This library works with two main objects: Lua__IO_Input and Lua__IO_Output. These objects facilitate communication between the script and the external world, such as displaying messages or providing debugging arguments to the script.

• Access: These objects can be accessed via the CANopen index 0x2040.
• Purpose:
  • Lua__IO_Input: Used to input data into the script.
  • Lua__IO_Output: Used to output data from the script.

By using these objects, the script can efficiently exchange information with external systems.

___________________________________________________________________________________________________________________________________________

number | string | nil value = IO.Read([option…])

You can read values from the input object using specified options.

Options:

• When the 'n' option is selected, if the value cannot be converted to a number, nil is returned.
• By passing an integer, you can read that many number of characters.

This function is equivalent to the standard io.read() function in Lua.

___________________________________________________________________________________________________________________________________________

IO.Write(string text…)

You can write text to the output object using this function.

• Behavior:
  • If the text is short enough, it is appended to the existing output string.
  • If the text is too long, the existing output string is overwritten.

This function is equivalent to the standard io.write() function in Lua.

___________________________________________________________________________________________________________________________________________

IO.Print(object…)

This function converts an object to a string and then writes the result to the output object.

This function is equivalent to the standard print() function in Lua.

2.2.3 Time

This library provides functions for time keeping and inserting delays in your scripts.

___________________________________________________________________________________________________________________________________________

integer time = Time.GetMs()

This function retrieves the current time in milliseconds since the device was powered on. The maximum value is limited to 2³² – 1.

___________________________________________________________________________________________________________________________________________

Time.WaitMs(integer time)

This function halts the script execution for a specified amount of time using this function.

___________________________________________________________________________________________________________________________________________

integer newStartTime = Time.WaitMsUntil(integer startTime, integer waitTime)

This function halts script execution for specified time from the provided starting time. This function can be used to implement periodic execution independent of logic execution duration.

2.2.3 CAN

This library is used to establish communication and transfer data over CAN. It provides functionality to send and receive CAN messages.

Note: This library does not support CAN FD (Flexible Data-rate).

___________________________________________________________________________________________________________________________________________

This library supports two modes of operation for CAN communication. The mode is selected during the initialization of CAN.

___________________________________________________________________________________________________________________________________________

CAN.Initialize(mode, boolean useExtendedFrame [, integer rxID, integer rxIDMask])

To use CAN communication, initialize CAN with this function. It can be called multiple times with different arguments, but only the last configuration will be used.

• rxIDMask Argument: Required only when the operating mode is set to CAN_RX_TX.

___________________________________________________________________________________________________________________________________________

CAN.Send(integer id, {integer [1:1-8]} data)

Use this function to send a CAN frame with a specified ID and data.

___________________________________________________________________________________________________________________________________________

CAN.Received({integer ID, integer Length, integer Data[1:1-8]} message)

This function is called whenever a CAN message is received.

• User Implementation Required: You must implement this function if CAN is initialized in CAN_RX_TX operating mode.

2.2.4 CANopen

This library is used to interact with the CANopen protocol stack.

• CANopen Object Representation: Internally, a CANopen object is represented as a table with two values: index and subindex.

___________________________________________________________________________________________________________________________________________

The CANopen stack includes a network management state machine that defines the communication behavior of a CANopen device. While there are multiple possible states, only a few are regularly used and available to the user.

___________________________________________________________________________________________________________________________________________

state = CANopen.GetNMTState()

Use this function to retrieve the currently set Network Management (NMT) state of the CANopen device.

___________________________________________________________________________________________________________________________________________

CANopen.SetNMTState(state)

Use this function to request the CANopen stack to change the Network Management (NMT) state of the device.

___________________________________________________________________________________________________________________________________________

number value = CANopen.GetObjectValue({integer, integer} object)

Use this function to retrieve the value of a specified object.

___________________________________________________________________________________________________________________________________________

CANopen.SetObjectValue({integer, integer} object, number value)

Use this function to set the value of a specified object.

2.2.5 Motor

This library is used to operate the motor. You can set operating parameters and retrieve the motor's current state and status.

___________________________________________________________________________________________________________________________________________

The motor can be controlled in three distinct modes. Depending on the chosen mode, the related reference will be used by the motor control algorithm.

___________________________________________________________________________________________________________________________________________

Motor control operates with a state machine that can be in one of multiple states. This state machine is responsible for top-level motor control functions such as initialization, execution, calibration, and error handling.

• State Execution: Some states are executed before the script runs and will not be visible to the user.

___________________________________________________________________________________________________________________________________________

Motor.Enable()

Enable motor control to have the motor operate according to the set mode and the corresponding reference value.

___________________________________________________________________________________________________________________________________________

Motor.Disable()

Disable motor control to stop the motor.

___________________________________________________________________________________________________________________________________________

Motor.Recover()

Use this function to attempt recovery from a motor control error.

Note: This function is only applicable when the motor control is in an error state.

___________________________________________________________________________________________________________________________________________

Motor.SetControlMode(mode)

Use this function to set the motor control mode.

___________________________________________________________________________________________________________________________________________

state = Motor.GetState()

Retrieve the current state of the motor control.

___________________________________________________________________________________________________________________________________________

integer warnings = Motor.GetWarnings()

Retrieve the currently active motor control warnings.

___________________________________________________________________________________________________________________________________________

integer protectionsLow = Motor.GetProtectionsLow()

Retrieve the currently active motor control protections (first 32 bits).

___________________________________________________________________________________________________________________________________________

integer protectionsHigh = Motor.GetProtectionsHigh()

Retrieve the currently active motor control protections (last 32 bits).

___________________________________________________________________________________________________________________________________________

number velocity = Motor.GetReferenceVelocity()

Retrieve the currently set reference velocity.

___________________________________________________________________________________________________________________________________________

Motor.SetReferenceVelocity(number velocity)

Set the reference velocity.

___________________________________________________________________________________________________________________________________________

number torque = Motor.GetReferenceTorque()

Retrieve the currently set reference torque.

___________________________________________________________________________________________________________________________________________

Motor.SetReferenceTorque(number torque)

Set the reference torque.

___________________________________________________________________________________________________________________________________________

number position = Motor.GetReferencePosition()

Retrieve the currently set reference position.

___________________________________________________________________________________________________________________________________________

Motor.SetReferencePosition(number position)

Set the reference position.

___________________________________________________________________________________________________________________________________________

number velocity = Motor.GetVelocity()

Retrieve the current motor velocity.

___________________________________________________________________________________________________________________________________________

number torque = Motor.GetTorque()

Retrieve the current motor torque.

___________________________________________________________________________________________________________________________________________

number position = Motor.GetPosition()

Retrieve the current motor position.

2.2.6 Digital

This library is used to manipulate digital I/Os (ports). It enables writing to and reading from digital ports.

___________________________________________________________________________________________________________________________________________

Every emDrive contains a set of digital ports that can be freely used by the user application. Some of these ports are writable, while others are read-only. Note that some ports might not be available on all emDrives. To see which ports are available, refer to the manual or the EDS of your emDrive

___________________________________________________________________________________________________________________________________________

number state = Digital.Get(port)

Retrieve the digital state of the port.

___________________________________________________________________________________________________________________________________________

Digital.Set(port, number state)

Set the digital state of the port.

2.2.7 Analog

This library is used to retrieve values from analog inputs (ports).

___________________________________________________________________________________________________________________________________________

Every emDrive contains a set of analog ports that can be freely used by the user application. All of these ports are read-only. Note that some ports might not be available on all emDrives. To see which ports are available, refer to the manual or the EDS of your emDrive.

___________________________________________________________________________________________________________________________________________

number value = Analog.Get(port)

Retrieve the analog value on the port.

3. Scripting

3.1 Setting Up Lua Scripting with Visual Studio Code

To make Lua scripting easier, follow these steps to set up Visual Studio Code with the Lua extension:

1. Install Visual Studio Code

   • If you don't have it yet, download and install Visual Studio Code.

2. Add the Lua Extension

   • Open Visual Studio Code.
   • Go to the Extensions view (click on the square icon on the sidebar or press Ctrl+Shift+X).
   • Search for "Lua" and install the Lua extension by sumneko.
     
     

3. Create a Folder for Libraries

   • Make a new folder on your computer to store the emdrive library. For example, you can name it D:\LuaLibraries.
   • Inside the folder extract the emdrive.7z which you get directly from us.
     D:\LuaLibraries\emdrive

4. Configure Developer Mode and Add Library Path

   • Open Visual Studio Code.
   • Press Ctrl+P to open the search bar.
   • Type >settings or >Open User Settings (JSON) and select "Open User Settings (JSON)" from the list.
     
     
     
     

5. Edit User Settings (JSON)

   • In the opened settings.json file, add the following code.
     

     "Lua.misc.parameters": [
         "--develop=true"
     ],
     "Lua.workspace.checkThirdParty": true,
     "Lua.workspace.userThirdParty": ["path_to_our_library"]

   • Make sure to keep any existing code intact. Add a comma at the end of the last line of the existing code, then paste the new code below it. Update the path to match your folder (D:/LuaLibraries). Use forward slashes instead of backslashes.
     

6. Save and Close

   • Save the changes to settings.json.
   • Close Visual Studio Code.

Example of "settings.json":

3.2 Getting Started with Lua Scripting

3.2.1 Create "firstscript.lua"

1. Create a New Folder

   • Make a new folder for your project.

2. Open the Folder with Visual Studio Code

   • Right-click the folder and select "Open with Code."
     
     
   • This will open Visual Studio Code with your new folder as the workspace.

3. Create a New Lua Script

   • In the Explorer window of Visual Studio Code, right-click and select "New File."
     
     
   • Name the file firstscript.lua (valid files are also "firstscript.txt", "firstscript". But it is better to use .lua which can use our emdrive Library in VS-code).

Note: Only the content of the script is transferred, not the file name.

Limitation: You can store only one script at a time on the emDrive.

3.2.2 Structure

Initialization Routine

• Function Requirement: Your script must include a function named Initialize().
• Execution: This function is the first to run when the script is executed and runs only once.
• Purpose: Use this function to initialize hardware and firmware, such as:
  • Setting up CAN
  • Enabling the motor
  • Setting outputs
  • Setting global variables

Loop Routine

• Function Requirement: Your script must include a function named Loop().
• Periodic Execution: This function runs periodically based on the LoopPeriodMs variable, which represents the period in milliseconds.
  • Setting the Period: LoopPeriodMs can be set globally or within the Initialize() function.
• Purpose: Use the Loop() function for tasks that need regular updates, such as:
  • Setting motor velocity
  • Parsing CAN frames
  • Reading inputs and setting output ports

Minimum Loop Period: The minimum allowed loop period is 10 milliseconds.
Execution Time: Ensure the Loop() function completes within the set period to maintain deterministic execution. If the loop takes longer, it can cause unpredictable behavior.

Priority Consideration: The firmware on the emDrive has higher priority than the script, which means script execution may be interrupted by higher priority tasks.
Use the resource monitor (see the Resource Monitor section) to measure loop duration and determine the minimum possible loop period.
The resource monitor can also show the maximum loop duration when interrupted by higher priority tasks.

Data Transfer: Transferring large data over CAN/CANopen will completely block script execution.

3.3 Executing script

After you've created your script, it is time to download it to emDrive and execute it. For these purposes, a few CANopen objects are provided, as seen in Figure 3. They are grouped together and are accessible at index 0x2040.

Table 52 provides a short description of objects related to script execution. More detailed meanings and use cases will be presented in the following sections.

3.3.1 Download/Upload

• To download the script to emDrive

1. click on Script object (0x2040, 0x5),
2. check “Write from file”,
3. click the “…” button which brings up an open file dialog where you select your script,
4. click “Write” button which will download the script to emDrive,
5. after successful download you should see a green progress bar with “Successful” label.

• To upload the script – this reads back the script currently stored on emDrive:

1. click on Script object (0x2040, 0x5),
2. click the “Read” button which will upload the script from emDrive and display it in the “Description” text box.
   

3.3.2 Control

Once the script has been successfully downloaded and verified, three control options become available through the Control object (0x2040, 0x3).

If a script is already executing when a new script is downloaded, the executing script is terminated as the download is initiated. After the new script is successfully downloaded and verified, it is automatically executed.

NOTE: The script is executed only after motor control has been initialized, which may delay script execution after the device powers on (usually by approximately 100 ms, although this value may vary).

3.3.3 Errors

When an error with the script is detected, the Status object (0x2040, 0x2) is set to a value signaling the type of error. There are four distinct types of errors that are detectable at different stages of script execution:

1. File is non-existent or corrupted (Status = 0): This is set when the script is not stored on the emDrive, or the stored script is corrupted. This error is triggered when script verification fails, either when the device powers on or whenever a new script is downloaded.

2. Compilation failed (Status = 1): This is set when the script could not be compiled, which could be caused by syntax errors or running out of memory. This error is triggered every time script compilation fails, such as when the script is restarted, executed for the first time, or downloaded while another script is already executing, causing the new script to be automatically compiled after downloading.

3. Execution failed (Status = 2): This is set when an error occurs during runtime—such as in initialization, loop, or other required routines—caused by several reasons like accessing nil objects, passing invalid values, missing functions, running out of memory, and others. This error is also raised if the Error() function is called from within the script.

4. Script timed out and was stopped (Status = 6): This is set when the initialization, loop, or other required routines take longer to execute than expected.

The initialization routine must execute within 100 ms, while the loop and other routines are required to execute within 2 × LoopPeriodMs.

Further details of what went wrong with the script can be retrieved from the output object.

All the above-mentioned errors are permanent. When an error is raised, emDrive protection is activated, and emDrive enters an error state from which it cannot recover (refer to the emDrive manual for more details about protections and error states). At this point, the script should be corrected for errors, downloaded to the emDrive, and then the device should be reset to clear the error.

3.3.4 Debugging

There is no proper debugging mechanism in place; however, utilizing Lua I/O objects and general-purpose CANopen objects, some form of limited debugging is possible. Using the input object, the user can control the flow of the program. The user can also write debug information to the output object. Additionally, all objects at index 0x3020, can be used freely for debugging purposes.

3.3.5 Resource monitor

The resource monitor is used to measure characteristics of the script during compile-time, initialization, and runtime (loop). All available objects relevant to resource monitoring are shown under object 0x2031 and described in Table 53.

Initialization and compile-time measurements are performed every time a new script is downloaded and executed or when an existing script is restarted. Memory and loop time monitoring must be explicitly enabled by setting EnableLoopMonitor to 1. This is because these measurements are calculated every loop, thereby shortening the processing time allocated to the script.

3.4 Using the emdrive Library

3.4.1 Option 1: Automatic Setup

1. Add Code to Script

   • In firstscript.lua, add the following line:
     
     

     require('emdrive')

2. Apply Path Modification

   • A pop-up window will appear in the bottom right corner. Click "Apply and modify."
   • After applying, delete the require('emdrive') line.
     
     

3. Check .vscode Folder

   • A new folder named .vscode will be created.
   • Inside, there will be a settings.json file containing the path to the library.

3.4.2 Option 2: Manual Setup

1. Create .vscode Folder

   • Manually create a .vscode folder in your workspace.

2. Create settings.json File

   • Inside the .vscode folder, create a settings.json file.

3. Add Library Path to settings.json

   • Add the following code to settings.json:
     
     

     
     

     {
         "lua.workspace.library": [
             "D:/LuaLibraries"
         ]
     }

4. Examples

4.1 Example 1: "Hello World"

Description:

Print "Hello World" every 100ms to IO_Output.

To make the script work, you need to have two functions: Initialize and Loop.

1. Copy the Code

   Copy the following code to an example.lua file:

   function Initialize()	
   	LoopPeriodMs = 100
   end
   
   function Loop()
       IO.Write("Hello World ")
   end

2. Load the Script on the Inverter

   • Go to 0x2040 0x05 - Script.
   • Select "Write from file" and click "...".
   • A pop-up window will appear. Locate the saved script and click "Open".
   • Click "Write".
     
     
     
     

3. Check if the Script is Valid

   • Go to 0x2040 0x02 - Status.
   • The value "3" indicates the downloaded file is valid.

4. Run the Script

   • Set 0x2040 0x03 - Control to 2.
   • If the script is running, the status value should be "5".

5. View the Output

   • Go to 0x2040 0x07 - IO_output.
   • Click "Read" to see the "Hello World" string in the Description window.
     
     

4.2 Example 2: Data types & variables

4.2.1 Example 2.1: Data types

Lua is a lightweight, high-level programming language known for its simplicity and flexibility. It has several basic data types, each serving a different purpose. Here are the main data types in Lua along with examples for each:

1. Nil
   Represents the absence of a value.
2. Boolean
   Represents a boolean value, either true or false.
3. Number
   Represents both integer and floating-point numbers.
4. String
   Represents a sequence of characters.
5. Table
   Represents associative arrays, which can be used as arrays, dictionaries, or other data structures.
   
6. Function
   Represents a callable function.

function Initialize()	
	LoopPeriodMs = 100
end

function Loop()
    
    -- 1. Nil
    local myVariable = nil
    IO.Print(myVariable)  -- Output: nil

    -- 2. Boolean
    local isTrue = true
    local isFalse = false
    IO.Print(isTrue)  -- Output: true
    IO.Print(isFalse)  -- Output: false

    -- 3. Number
    local integerNumber = 42
    local floatingNumber = 3.14
    IO.Print(integerNumber)  -- Output: 42
    IO.Print(floatingNumber)  -- Output: 3.14

    -- 4. String
    local myString = "Hello, Lua!"
    IO.Print(myString)  -- Output: Hello, Lua!

    -- 5. Table
    local myTable = { key1 = "value1", key2 = "value2" }
    IO.Print(myTable.key1)  -- Output: value1
    IO.Print(myTable.key2)  -- Output: value2

    local arrayTable = { "apple", "banana", "cherry" }
    IO.Print(arrayTable[1])  -- Output: apple

    -- 6. Function
    local function myFunction(a, b)
      return a + b
    end
    IO.Print(myFunction(2, 3))  -- Output: 5
 
    -- 6. Anonymous function
    local anonFunction = function(x, y)
      return x * y
    end
    IO.Print(anonFunction(4, 5))  -- Output: 20

end

4.2.2 Example 2.2: Variables

1. Global variables
   Global variables are accessible from anywhere in the program unless shadowed by a local variable of the same name. By default, any variable declared without the local keyword is global.
   

   myGlobalVariable = 10  -- Global variable
   
   function printGlobal()
     print(myGlobalVariable)
   end
   
   printGlobal()  -- Output: 10

2. Local Variables
   Local variables are only accessible within the block or function where they are declared. They help avoid polluting the global namespace and can be used to manage scope more effectively.
   

   local myLocalVariable = 20  -- Local variable
   
   function printLocal()
     local myLocalVariable = 30  -- Local to this function
     print(myLocalVariable)
   end
   
   printLocal()  -- Output: 30
   print(myLocalVariable)  -- Output: 20

3. Table fields
   Variables can also be fields of tables, allowing for the creation of more complex data structures like arrays, dictionaries, and objects.
   

   local myTable = {
     field1 = "Hello",
     field2 = "World"
   }
   
   print(myTable.field1)  -- Output: Hello
   print(myTable.field2)  -- Output: World

Variable scope

• Global Scope: Variables declared outside of any function or block are global by default.
• Local Scope: Variables declared with the local keyword within a function, block, or loop are local to that block.

1. Global vs. Local
   

   myGlobal = "I am global"
   
   function testScope()
     local myLocal = "I am local"
     print(myGlobal)  -- Accessible
     print(myLocal)   -- Accessible
   end
   
   testScope()
   
   print(myGlobal)  -- Accessible
   -- print(myLocal) -- Error: myLocal is not accessible here

   
   
2. Local Variable Shadowing
   

   local x = 5  -- Local variable in the main chunk
   
   function shadowTest()
     local x = 10  -- Local variable in the function
     print(x)  -- Output: 10
   end
   
   shadowTest()
   print(x)  -- Output: 5

Global variables and tables use a lot of memory, especially in embedded systems. To save memory, it's best to use local variables whenever possible. 
If you use a global variable at the start of your code and don't need it later, clear the global variable to free up memory. You can do this by adding the following code:

myGlobalVariable = nil

4.3 Example 3: Inputs/Outputs

4.3.1 Example 3.1: Use of digital inputs & outputs

Turn low side 1 - ON when switch on digital pin 1 is switched ON.

function Initialize()	
	LoopPeriodMs = 10
end

function Loop()

    local switch = Digital.Get(DIGITAL_IN_1)

    if switch == 1 then
        Digital.Set(LOW_SIDE_1, 1)
    else
        Digital.Set(LOW_SIDE_1, 0)
    end
end

4.3.2 Example 3.2: Use of analog inputs

Print analog value of analog input 1 when switch on digital pin 1 is switched ON.

function Initialize()	
	LoopPeriodMs = 10
end

function Loop()

    local switch = Digital.Get(DIGITAL_IN_1)

    if switch == 1 then
        local rawVal = Analog.Get(ANALOG_IN_1)
        IO.Print(rawVal)    
    end
end

4.4 Example 4: Blink LED

4.4.1 Example 4.1: Blink LED - "delay"

Loop period is set to 1000ms
LED is connected on low side 1.
Blink LED every 0.5s with Time.WaitMs().

function Initialize()	
	LoopPeriodMs = 1000
end

function Loop()

    local ledState = Digital.Get(LOW_SIDE_1)

    if(ledState == 0) then
        Digital.Set(LOW_SIDE_1, 1)
    else
        Digital.Set(LOW_SIDE_1, 0)
    end

    Time.WaitMs(500)

end

If we set the LoopPeriodMs to 100ms, the script stops running and shows a status of "6", meaning "Script timed out and was stopped."

Here are the key points to understand:

• Time.WaitMs() Function: This function pauses the script for a specified time. In our example, it pauses for 0.5 seconds.
• LoopPeriodMs Setting: We set the script to loop every 100ms.
• Error Explanation: Since the script must loop every 100ms but pauses for 0.5 seconds, it causes an error.

Important Note: Be very careful when using the Time.WaitMs() function to avoid such errors.

4.4.2 Example 4.2: Blink LED - using loop time

We want the LED to blink every 0.5 seconds, while the main loop runs every 10ms. Here's how we do it:

Main_loop_period = 10
Counter = 1


function Initialize()	
	LoopPeriodMs = Main_loop_period
end

function Loop()

    if ((Counter)*Main_loop_period)%500==0 then
    
        local ledState = Digital.Get(LOW_SIDE_1)

        if(ledState == 0) then
            Digital.Set(LOW_SIDE_1, 1)
        else
            Digital.Set(LOW_SIDE_1, 0)
        end

    end
 
    if Counter<50 then
        Counter=Counter+1
    else
        Counter=1
    end

end

4.4.3 Example 4.3: Blink LED - using processor time

The script initializes a start time variable and defines two functions. In the Loop function, the script checks if the StartTime is nil and if so, sets it to the current time in milliseconds.
The Loop function then continuously gets the current time in milliseconds. If 500 milliseconds have passed since the StartTime, it resets the StartTime to the current time.
It then gets the state of a digital output LOW_SIDE_1.
If LOW_SIDE_1 is off (state is 0.0), it turns it on (state to 1.0).
If LOW_SIDE_1 is on (state is 1.0), it turns it off (state to 0.0).

This process repeats every 500 milliseconds, toggling the state of LOW_SIDE_1 each time.

StartTime = nil

function Initialize()	
	LoopPeriodMs = 10
end

function Loop()

    --Execute only once at the start of the loop
    if(StartTime == nil) then
        StartTime = Time.GetMs()
    end

    --Chechk every loop what is the time
    local CurrentTime = Time.GetMs() 

    if (CurrentTime - StartTime >= 500) then
        StartTime = CurrentTime

        local ledState = Digital.Get(LOW_SIDE_1)

        if(ledState == 0) then
            Digital.Set(LOW_SIDE_1, 1)
        else
            Digital.Set(LOW_SIDE_1, 0)
        end

    end
end

4.5 Example 5: CAN send

4.5.1 Example 5.1: (CAN send simple message)

To send a CAN message every 100ms with an ID of 0x205 and data value 500 using the first 2 bytes, follow these steps: 

1. Use Template:

   • Start with example 4.3 as a template.

2. Add Variables and Functions:

   • Define a CanID variable.
   • Initialize CAN with the CAN.Initialize() function.

3. Sending Parameters:

   • Use the CAN_TX_ONLY parameter for sending.
   • Messages will not be extended.
   • Set filters to 0 since we are only sending.

4. Modify the Code:

   • Delete the code for toggling the output.

5. Create Custom Function:

   • Create a function that is called every 100ms.
   • Name the argument Data_raw.
   • Split Data_raw into 2 bytes.
   • Send the data using the CAN.Send() function.

CanID = 0x205

StartTime = nil

function Initialize()

    CAN.Initialize(CAN_TX_ONLY,false,0,0)

	LoopPeriodMs = 10
end

function Loop()

    --Execute only once at the start of the loop
    if(StartTime == nil) then
        StartTime = Time.GetMs()
    end

    --Chechk every loop what is the time
    local CurrentTime = Time.GetMs() 

    if (CurrentTime - StartTime >= 100) then
        StartTime = CurrentTime
        SendData(500)
    end
end

function SendData(Data_raw)
    local val = Data_raw
    local byte0 = math.floor(val) & 0xFF
    local byte1 = (math.floor(val) & 0xFF00) >> 8
    CAN.Send(CanID,{byte0,byte1,0,0,0,0,0,0})
end

In this example we only need 2 bytes, thus we don't need to send all 8 bytes out. You could do this instead:

 CAN.Send(CanID,{byte0,byte1})

4.5.2 Example 5.2 : CAN send extended message (J1939)

We will do the same as in example 5.1 except we will send an extended message (It will be a J1939 message PH3 - the data order might be different in the standard).

 
ID = 0x18FF8203. 

The only thing we need to change is 2 lines, we need to change the CanID and in the CAN.Initialize() function, the boolean value to true. If we change only the CanID then the message will still be sent out but the ID will be 0x199 (last 3 digits of - ID 0x18FF8199).

CanID = 0x18FF8199
CAN.Initialize(CAN_TX_ONLY,true,0,0)

4.6 Example 6: CAN receive

4.6.1 Example 6.1 : CAN receive

In this example we will turn ON and OFF a LED that is connected on low side 1 with a received can message.
The Can ID has to be 0x123 and we will send only one byte of data. If the value of data is 1 then the LED will be turned ON, otherwise it will be turned OFF. 
 
To use the CAN receive function we need to change the CAN.Initialite() and add a function called "CAN.Received(message)". With the following code we always go into the CAN.Received() function when a message is received and then we check if the ID is correct.

function Initialize()
    CAN.Initialize(CAN_RX_TX,false,0,0)
	LoopPeriodMs = 10
end

function Loop()


end

function CAN.Received(message)
    if (message.ID == 0x123) then
        IO.Print(" Data1: ", message.Data[1])
        if(message.Data[1] == 1) then
            Digital.Set(LOW_SIDE_1, 1)
        else
            Digital.Set(LOW_SIDE_1, 0)
        end
    end
end

We can also add a filter so we only go into the CAN.Received() when the message has a proper ID. We achieve this with the following code.

function Initialize()
    CAN.Initialize(CAN_RX_TX,false,0x123,0x123)
	LoopPeriodMs = 10
end

function Loop()


end

function CAN.Received(message)
    --if (message.ID == 0x123) then
    IO.Print(" Data1: ", message.Data[1])
    if(message.Data[1] == 1) then
        Digital.Set(LOW_SIDE_1, 1)
    else
        Digital.Set(LOW_SIDE_1, 0)
    end
    --end
end

4.7 Example 7: Read & Set CANopen objects

In this example, we'll use an analog input (HW AIN1) as a throttle to set the motor velocity reference (object 0x3010 0x05). We will also read this object and print its value to the Lua output. Additionally, we'll limit the maximum RPM using the math library to prevent the motor from running away if there's a problem with the analog reading.

0V = 0RPM
5V = 200RPM

For this example to work you need an inverter that is configured to work with the connected motor. You need to be first able to spin it in velocity mode using the configurator.
When you start the script go to operational and turn on PWMs manually.

If the analog throttle is damaged (either a short circuit or a broken circuit), there is no safety system in place. Here’s what can happen:

If the circuit is broken, no voltage will be applied, and the RPM will be 0.
If there is a short circuit, the inverter will receive the full 5V on the analog input, causing the RPM to go to the maximum.

To prevent these issues, we need to add safety features. These will be demonstrated in Example 8.

VelocityRef = {0x3010, 0x05}

function Initialize()
	LoopPeriodMs = 10
end

function Loop()
   

    local rpm = Analog.Get(ANALOG_IN_1) * 40
    rpm = math.min(rpm,200)

    CANopen.SetObjectValue(VelocityRef, rpm)
    
    local VelRef_from_CANopen = CANopen.GetObjectValue(VelocityRef)

    IO.Print(VelRef_from_CANopen)
end

4.8 Example 8: Demo application

4.8.1 Example 8.1 : Demo application using CANopen objects.

In this example, we will demonstrate how to use the HW AIN1 input for a simple throttle control with a potentiometer (0-5V).

• Throttle Input: HW AIN1 (0-5V Potentiometer)
  • Minimum RPM: 0 (corresponds to 0.5V)
  • Maximum RPM: 200 (corresponds to 4.5V)
  • Motor Stop Conditions:
    • If the throttle voltage is below 0.2V or above 4.8V, the motor will stop to protect against short and break issues.
  • PWM Enable Condition:
    • If the throttle voltage is below 0.5V, the PWM signals will be enabled

function Initialize()

    CANopen.SetObjectValue(VelocityRef, 0) -- Set Velocity ref to 0
	CANopen.SetObjectValue(ControlMode, 1) -- Set velocity mode
	CANopen.SetNMTState(CO_OPERATIONAL)    -- Go into operational mode

	LoopPeriodMs = 100
end

function Loop()
    local throttleVoltage = Analog.Get(ANALOG_IN_1)
    -- Decide whether to enable or disable the motor
    if Digital.Get(DIGITAL_IN_1) == 1 then
        -- only enable if voltage on 0.2 < ANALOG_IN_1 < 0.5 V so the motor does not start ang goes to high RPM
        if  (0.2 < throttleVoltage and throttleVoltage < 0.5) then
            CANopen.SetObjectValue(PwmControl, 1)
        end
    else
        CANopen.SetObjectValue(PwmControl, 0)
    end

    if (throttleVoltage > 0.2 and throttleVoltage < 4.8) == true then
           -- Map values 0.5 - 4.5 V to 0 - 200 RPM and
            local rpm = (throttleVoltage - 0.5) / 4 * 200
            rpm = math.min(rpm, 200)
            rpm = math.max(rpm, 0)
            CANopen.SetObjectValue(VelocityRef, rpm)
    else
        CANopen.SetObjectValue(VelocityRef, 0)
        CANopen.SetObjectValue(PwmControl, 0)
    end
end

4.8.2 Example 8.2 : Demo application using dedicated motor library.

In this example we will have the same functionality of the code as in example 8.1. but with the use of motor library
With the use of the motor library the code is easier to read and write than example 8.1.

function Initialize()

    Motor.SetReferenceVelocity(0)       -- Set Velocity ref to 0
	Motor.SetControlMode(VELOCITY_MODE) -- Set velocity mode
	CANopen.SetNMTState(CO_OPERATIONAL) -- Go into operational mode

	LoopPeriodMs = 100
end

function Loop()
    local throttleVoltage = Analog.Get(ANALOG_IN_1)
    -- Decide whether to enable or disable the motor
    if Digital.Get(DIGITAL_IN_1) == 1 then
        -- only enable if voltage on 0.2 < ANALOG_IN_1 < 0.5 V so the motor does not start ang goes to high RPM
        if  (0.2 < throttleVoltage and throttleVoltage < 0.5) then
            Motor.Enable()
        end
    else
        Motor.Disable()
    end

    if (throttleVoltage > 0.2 and throttleVoltage < 4.8) == true then
           -- Map values 0.5 - 4.5 V to 0 - 200 RPM and
            local rpm = (throttleVoltage - 0.5) / 4 * 200
            rpm = math.min(rpm, 200)
            rpm = math.max(rpm, 0)
            Motor.SetReferenceVelocity(rpm)
    else
        Motor.SetReferenceVelocity(0)
        Motor.Disable()
    end
end

4.9 Example 9: Throttle script (state - machine)

Throttle Control

• Adjusting the Throttle: Use the potentiometer connected to Analog_IN_1.
• Protection: The potentiometer is protected against short and break circuits.
• Deadband: A deadband of 0.3V is set for the potentiometer.
• Speed Limits (needs to be set in objects described below): 
  • Minimum speed: 0 RPM
  • Maximum speed: 300 RPM

Motor Operation

• Activation:
  • The motor runs only when digital pin 1 (ON/OFF switch) is connected.
  • Change motor direction using a switch on digital pin 3.
• Speed Setting:

  • Forward max speed: Object 0x3020 0x0D

  • Reverse max speed: Object 0x3020 0x0E

  • Switching direction at max speed changes to the corresponding reverse speed.

LED Diagnostics

• LED Indicator (HS1):
  • On: System working normally.
  • Blinking: System in error mode.
• Error Blink Codes:
  • Error 2: Blinks twice, then pauses.
  • Error 3: Blinks three times, then pauses.

Voltage and RPM Details

• Working Voltage Range:
  • Minimum RPM: at 0.5V
  • Maximum RPM: at 4.5V
  • Deadband: 0.3V
• Error Conditions:
  • ERROR1: Voltage out of bounds
  • ERROR2: Analog_IN_1 < (Min_Volt - Deadband)
  • ERROR3: Analog_IN_1 > (Max_Volt + Deadband)

CANopen Error Messages

• Error Message (0x80 + nodeID):
  • Sent every 100ms in error state.
  • Data length: 8 bytes.
  • Byte 0 Mapping:
    • Bit 0: Throttle potentiometer error out of bounds
    • Bit 1: Throttle potentiometer break circuit error
    • Bit 2: Throttle potentiometer short circuit error
• Warning Message (0x180 + nodeID):
  • Sent every 100ms in start state.
  • Data length: 8 bytes.
  • Byte 0: Warning code 0x01 (Motor disabled, potentiometer not in min position)

If the motor spins at Forward max speed and you switch the direction with the switch then it will spin at Reverse max speed

-- Limits
MAX_RPM = 300
MIN_RPM = -300

-- Objects
FORWARD_MAX_SPEED_ID = {0x3020, 0xD}
REVERSE_MAX_SPEED_ID = {0x3020, 0xE}
LED_ID 				 = {0x30A4, 0x02}


-- Inputs
ENABLE_SW 	 = DIGITAL_IN_1
DIRECTION_SW = DIGITAL_IN_2
THROTTLE_IN  = ANALOG_IN_1
DIRECTION_IN = DIGITAL_IN_3


-- Voltage thresholds
THROTTLE_MIN_V = 0.5
THROTTLE_MAX_V = 4.5
DEADBAND 	 = 0.3


ERROR	  = 0
ERROR_reg = 0
WARNINGS  = 0


StartTime1	= nil
StartTIme2	= nil
StartTime3 	= nil
StartTime4 	= nil
FlagCounter = 0


DIN		  = {ON = 1, OFF = 0}
LED 	  = {OFF = 0x0, ON = 0x1}
DIRECTION = {FORWARD = 1, REVERSE = 0}

-- Application FSM
Application = {}


function Initialize()
	CAN.Initialize(CAN_TX_ONLY,false,0,0)

	Application.NextState = "Idle"

    Motor.SetReferenceVelocity(0)
	Motor.SetControlMode(VELOCITY_MODE)

	LoopPeriodMs = 10
end


function Loop()
	Application[Application.NextState]()
end


Application.Idle = function ()
	CANopen.SetObjectValue(LED_ID, LED.ON)
	CANopen.SetNMTState(CO_OPERATIONAL)
	Application.NextState = "Start"
end


Application.Start = function ()


    -- IF enable switch is off go to stop state
    if (Digital.Get(ENABLE_SW) == DIN.OFF ) then
		Application.NextState = "Stop"
		return
	end


    -- Get voltage
	local throttleVoltage = Analog.Get(THROTTLE_IN)


    -- Go into error state if throttle voltage is out of bounds
    if OutOfBounds(throttleVoltage, (THROTTLE_MIN_V - DEADBAND), (THROTTLE_MAX_V + DEADBAND)) == true then
		ERROR = (ERROR or 0) | 1
		Application.NextState = "Error"
		return
	end


    -- Check that voltage is bellow minimal throttle voltage - so that the motor does not start at high speed
	if Motor.GetState() == MOTOR_OFF then
		if throttleVoltage < (THROTTLE_MIN_V) then
            Motor.Enable()
			WARNINGS = WARNINGS & Negate_Xbit(1, 8)
            return
		else
			WARNINGS = (WARNINGS or 0) | 1
        end
	end

	-- Only set velocity reference when pwms are enabled
	if ((Motor.GetState() == MOTOR_RUN) and (throttleVoltage >= 0.5)) then
		-- Calculate Voltage
    	--local rpm = ((throttleVoltage - THROTTLE_MIN_V) * MAX_RPM) / (THROTTLE_MAX_V - THROTTLE_MIN_V)
		local rpm = ((throttleVoltage - THROTTLE_MIN_V) * GetMaxSpeed()) / (THROTTLE_MAX_V - THROTTLE_MIN_V)
    	-- Limit RPM
    	rpm = math.min(rpm, MAX_RPM)
    	rpm = math.max(rpm, MIN_RPM)
		IO.Print("REF: ", rpm)
    	-- Set ref
		Motor.SetReferenceVelocity(rpm)
	end

	-- Send warnings every 100ms
	local CurrentTime = Time.GetMs()
	if((StartTIme2 == nil) or (CurrentTime-StartTIme2) >= 100) then
		SendWarnings()
	end
end


Application.Stop = function ()
    Motor.SetReferenceVelocity(0)
	Motor.Disable()
    --When eneble sw is activated go to start state
	if (Digital.Get(ENABLE_SW) == DIN.ON) then
		Application.NextState = "Start"
	end
end

Application.Error = function ()

    Motor.Disable()
	Motor.SetReferenceVelocity(0)

	--local ledValue = CANopen.GetObjectValue(LED_ID)
    local throttleVoltage = Analog.Get(THROTTLE_IN)
	local ErrorBlinkCounter = 0
	local CurrentTime

	--If bit 0 = 1 then OutOfBounds is detected
	if (ERROR & 1) == 1 then
		if throttleVoltage < (THROTTLE_MIN_V - DEADBAND) then
			ERROR = ERROR | 2
			ERROR_reg = ERROR_reg | 1 -- set the generic error register
		elseif throttleVoltage > (THROTTLE_MAX_V + DEADBAND) then
			ERROR = ERROR | 4
			ERROR_reg = ERROR_reg | 1 -- set the generic error register
		else
			-- Clear ERROR bit 0, 1, 2
			ERROR = ERROR & Negate_Xbit(7, 16)
			-- Clear the generic error register
			ERROR_reg = ERROR_reg | Negate_Xbit(1, 8)
		end
	end

	-- Send Errors every 100ms
	CurrentTime = Time.GetMs()
	if ((StartTime1 == nil) or (CurrentTime - StartTime1) >= 100) then
		StartTime1 = CurrentTime
		SendError()
	end

	-- Determine how many times we want to blink the led
    if ((ERROR & 2) >> 1) == 1 then
        ErrorBlinkCounter = 2
    elseif ((ERROR & 4) >> 2) == 1 then
        ErrorBlinkCounter = 3
    end

    -- Start the blinking cycle if enough time has passed
	CurrentTime = Time.GetMs()
    if StartTime3 == nil or (CurrentTime - StartTime3) >= 3000 then
        StartTime3 = CurrentTime
        FlagCounter = 0
    end

    -- Handle the blinking logic
    if FlagCounter < 2 * ErrorBlinkCounter then
        if StartTime4 == nil or (CurrentTime - StartTime4) >= 300 then
            StartTime4 = CurrentTime
            FlagCounter = FlagCounter + 1

            -- Toggle LED
            --if ledValue == 0  then
            if FlagCounter % 2 == 1 then
				CANopen.SetObjectValue(LED_ID, LED.ON)
            else
                CANopen.SetObjectValue(LED_ID, LED.OFF)
            end
        end
	else
		-- Ensure the LED is off during the pause period
        CANopen.SetObjectValue(LED_ID, LED.OFF)
    end

    if ERROR == 0 then
		FlagCounter = 0
		Application.NextState = "Idle"
		return
	end
end


function GetMaxSpeed()
	if Digital.Get(DIRECTION_IN) == DIRECTION.FORWARD then
		return CANopen.GetObjectValue(FORWARD_MAX_SPEED_ID)
	end
	return CANopen.GetObjectValue(REVERSE_MAX_SPEED_ID)
end


function SendError()
	-- Send on ID + nodeID; we get the NodeId from CANopen off the inverter
	local CanID = 0x80 + CANopen.GetObjectValue({0x100B, 0x00})
	local byte0 = ERROR & 0xFF
	local byte1 = (ERROR & 0xFF00) >> 8
	local byte2 = ERROR_reg & 0xFF
	CAN.Send(CanID,{byte0, byte1, byte2, 0, 0, 0, 0, 0})
end

function SendWarnings()
	-- Send on PDO + nodeID;
	local CanID = 0x180 + CANopen.GetObjectValue({0x100B, 0x00})
	local byte0 = WARNINGS & 0xFF
	CAN.Send(CanID,{byte0, 0, 0, 0, 0, 0, 0, 0})
end


function OutOfBounds(throttleVoltage, minVal, maxVal)
    if (throttleVoltage < minVal) or (throttleVoltage > maxVal) then
        return true
    else
        return false
    end
end


--- Fuctino to negate bits
---@param value number Value to negate
---@param xBit number Number of bites e.g 16bit => xBit = 16
function Negate_Xbit(value, xBit)
    local negated = 0
    for i = 0, (xBit - 1) do
        if (value & (1 << i)) == 0 then
            negated = negated + (1 << i)
        end
    end
    return negated
end

4.10 Example 10: Read protections of motor control in Lua

Purpose:
This script is designed to monitor and report various hardware errors in motor control systems, using Lua to check status registers for issues such as overtemperature, voltage discrepancies, and communication failures.

Description:

• Protection_bits Table: Lists each error with a unique bitmask for identification.
• Initialize Function: Sets initial conditions, including the loop frequency.
• Loop Function: Repeatedly retrieves the current error status, checks each potential error against the current status, and prints messages for any active errors.

Usage:
It is best to use only the protections that you need to check or send. By doing this, you can make the Protection_bits table smaller, which in turn reduces memory usage—a crucial consideration in environments with limited resources. Either way, if the value returned from the function is greater than 0, an error has occurred.

local Errors = {}
local Protection_bits = {
    {0x1, "sw_phase_error"},
    {0x2, "sw_DC_link_overvoltage_error"},
    {0x4, "sw_DC_link_undervoltage_error"},
    {0x8, "bridge_overtemperature_error"},
    {0x10, "capacitor_overtemperature_error"},
    {0x20, "motor_overtemperature_error"},
    {0x40, "current_offset_error"},
    {0x80, "CAN_command_timeout_error"},
    {0x100, "system_self_test_failed_error"},
    {0x800, "motor_feedback_error"},
    {0x8000, "CAN_communication_error"},
    {0x10000, "logic_supply_monitor_error"},
    {0x20000, "dc_link_overvoltage_comparator_error"},
    {0x80000, "gatedriver_error"},
    {0x100000, "HV_interlock"},
    {0x200000, "motor_temperature_sensor_fail"},
    {0x400000, "capacitor_temperature_sensor_fail"},
    {0x800000, "bridge_temperature_sensor_fail"},
    {0x1000000, "bridge_fault"},
    {0x2000000, "logic_supply_fault"},
    {0x4000000, "bus_bar_fault"},
    {0x8000000, "system_initialization_error"},
    {0x10000000, "fault_Vrefs_chip"},
    {0x20000000, "application_error_state"},
    {0x40000000, "motor_control_error"}
    --{0x80000000, "error_extended"}
}

-- Initialize
function Initialize()
    LoopPeriodMs = 10
end

function Loop()
    local protections = Motor.GetProtectionsLow()
    
    for i = 1, #Protection_bits do
        local bitmask = Protection_bits[i][1]
        local varname = Protection_bits[i][2]
        Errors[i] = {bitmask = bitmask, name = varname, state = (protections & bitmask) == bitmask}
    end

    -- Example usage to print all active errors
    for i = 1, #Errors do
        if Errors[i].state then
            IO.Print("Error detected: " .. Errors[i].name)
        end
    end
end

5. Benchmark

5.1 Examples for benchmark:

5.1.1 00_Empty_script

function Initialize()
	LoopPeriodMs = 10
end

function Loop()
end

5.1.2 01_GetObject

function Initialize()
	LoopPeriodMs = 10
end

function Loop()
	for i = 1,100 do
		CANopen.GetObjectValue({0x30B0, 0x04})
	end
end

5.1.3 02_GetObject_with_library

function Initialize()
	LoopPeriodMs = 10
end

function Loop()
	for i = 1,100 do
		Digital.Get(DIGITAL_IN_4)
	end
end

5.1.4 03_GetSet

function Initialize()
	LoopPeriodMs = 10
end

function Loop()
	for i = 1,50 do
		local throttle = CANopen.GetObjectValue({0x3090, 0x01})
		CANopen.SetObjectValue({0x3010, 0x05}, throttle * 40) --at 4.5V = 180RPM
	end
end

5.1.5 04_GetSet_with_library

function Initialize()
	LoopPeriodMs = 10
end

function Loop()
	for i = 1,50 do
		local throttle = Analog.Get(ANALOG_IN_1)
		Motor.SetReferenceVelocity(throttle * 40) --at 4.5V = 180RPM
	end
end

5.2 Results

We loaded each script onto the inverter and started the "Resource Manager." We ran the script for a specific period and logged the variables to a live chart, from which we then created the following table:

Examples from 05 onwards can be found under the title 4. Examples.

Examples 01, 03, and 05 have too much loop time and were excluded from the chart.

As you can see from the table and charts, reading and writing values directly from the CANopen stack takes longer than using our library. For example, the 01_GetObject example has an average loop time execution of 5ms, whereas the 02_GetObject_with_library example has an average time of 510µs, which is approximately 10 times faster. Based on these results, it is better to use functions that directly interact with the inverter instead of the CANopen stack, where possible.

We can also see that the delay function used in example 05_Timer_example_4_1 has a very long loop time because we used the delay to blink an LED. This function must be used with caution and only for small delays if you have no other option.

For writing applications, we recommend using a state machine, which is more reliable. With a state machine, you have more control over what happens in each state and can properly define the transitions between states.

In section "5.3 Live chart data for each example", we can see the loop time, RAM used and RAM free for a specific time period. We can se that we have some spikes in loop time, which can indicate that some specific part of the code was executed or that the script was interrupted with a higher priority task. We can also see that the  RAM usage can very based on which part of the code is executed.

5.3 Global variables benchmark

In this section, we will demonstrate how the number of global variables affects script RAM usage and loop execution time.

Below is the code that will be used to test 10 global variables. We will increase the number of global variables to 20, 30, 100, and 150, but the principle will remain the same

Global1 = 1
Global2 = 1
Global3 = 1
Global4 = 1
Global5 = 1
Global6 = 1
Global7 = 1
Global8 = 1
Global9 = 1
Global10 = 1

function Initialize()
	LoopPeriodMs = 10
end

function Loop()
  IO.Print(Global1)
  IO.Print(Global2)
  IO.Print(Global3)
  IO.Print(Global4)
  IO.Print(Global5)
  IO.Print(Global6)
  IO.Print(Global7)
  IO.Print(Global8)
  IO.Print(Global9)
  IO.Print(Global10)
end

In the table below, we recorded the data for different sets of global variables. We can observe that as the number of global variables increases, the compile time, initialization time, loop execution time, and RAM usage all increase. It is important to remember that we are limited by the loop execution time set in the initialize() function. If we exceed that time, we encounter an error.

More importantly, we need to carefully manage the number of global variables because excessive use can lead to memory overflow. As shown in the table below, having 150 global variables consumes around 75% of the RAM, but our code has almost no functionality. If we add the following code right after the Loop() function:

for i = 1,50 do
		local throttle = CANopen.GetObjectValue({0x3090, 0x01})
		CANopen.SetObjectValue({0x3010, 0x05}, throttle * 40) --at 4.5V = 180RPM
end

We see that the RAM usage jumps to 98%. This shows that RAM usage depends not only on the number of global variables but also on the quality of the code itself. Therefore, we need to write efficient code, which means avoiding the use of global variables, using local variables, and implementing proper algorithms.

For these reasons, it is difficult to specify the maximum number of global and local variables. We recommend testing your script continuously during development.

6. Best practices

For further insights and practical tips, I recommend exploring "Programming in Lua," available at: Programming in Lua. Authored by experts in the field, this comprehensive resource offers invaluable guidance for Lua developers. It's worth noting that the entire topic is accessible free of charge as of April 24, 2024. Additionally, some sections of the topic include examples to further illustrate key concepts and techniques.

6.1 Minimizing Global Variables

The most common problem with Lua scripting occurs when the script becomes "big" and the programmer uses only or to much global, resulting in an "out of memory" error. In Lua scripting, it's imperative to exercise caution with global variables to prevent memory exhaustion and script failures, especially on embedded systems. Emphasizing the utilization of local variables whenever possible is paramount. By minimizing global variable usage, we mitigate the risk of memory overflow and enhance script performance.

7. Known issues and limitations

This section describes known issues and limitations, their causes, and solutions or mitigations if they exist.

7.1 Issues

7.1.1 Lua is not enabled

Error 0x06070010 when loading a script may indicate Lua object 0x2040 0x01 isn't set to 1. To resolve, ensure proper access level in Configurator to unlock this feature. If you do not have the proper access level contact us.

7.1.2 Output object out of memory error

When reading an output object whose value is periodically changing by the script, it is possible that an "Out of memory" error, as shown in Figure 8, may be reported by the emDrive Configurator.

Cause: unsynchronized reading and writing to output object by script and emDrive Configurator at the same time.

Solution: read output object again.

7.1.3 IO.Print() isn't functioning

If IO.Print() isn't functioning, it may signal an outdated firmware version. FW 1.12.2 -  lacks support, while FW 1.13.2 onwards enables the function.

7.1.4 Protections

If multiple protections are active, the CANopen read wont work for the protection object. (New FW will fix this issue)

Throttle Application Manual

1. Introduction

1.1 Overview

The Throttle application allows the user to implement a simple throttle control directly on the emDrive. Input devices can be connected directly to the emDrive and mapped to the throttle application. The application calculates the desired output based on these inputs and passes it to motor control. The output can be used as either a torque input or a speed input in the motor controller, depending on which CANopen object the output is mapped to. No further configuration is needed to switch the application from one output mode to the other.

1.2 Features

The Throttle application supports the following features:

• Throttle Module
  Functionality: Calculates the desired output based on mapped input and configuration parameters.
  Capabilities: Can be configured as unidirectional or bidirectional.
• Brake Module
  Functionality: Calculates the desired brake torque based on mapped input and configuration parameters.
  Capabilities: Unidirectional only, with brake torque always in the opposite direction to motor rotation.

  If the desired output is speed, the brake should be disabled.

• Pump Control Module
  Functionality: Controls the pump, turning it on or off depending on motor and drive temperature.
• Pre-charge Module
  Functionality: Manages the pre-charge process at startup.
• DC-DC Turn on Delay Module
  Functionality: Delays the activation of the DC-DC converter after startup to ensure controlled power application.
• SOC Monitoring Module
  Functionality: Monitors the State of Charge (SOC) of the battery.
  Capabilities: Reduces the maximum allowed torque when SOC is below a specified threshold.

  Requires an external Battery Management System (BMS) to operate correctly.

• Charging Detection Module
  Functionality: Detects when the battery is charging and disables the drive during the charging process.
• Input Mapping
  Functionality: Allows certain inputs to the throttle application to be mapped to CAN objects on the emDrive.

All throttle application features can be independently enabled or disabled (except the brake module, which requires the throttle module to be enabled). This is done by setting the Thr1_Enable CAN objects of the throttle application as detailed in Table 1.

2. Input and Output mapping

Input and output mapping for the Throttle application is managed using the Thr1_Obj object, which stores the CANOpen indexes and subindexes of the inputs and outputs mapped to the Throttle application variables. You can remap any variable to a different input by writing the CANOpen index and subindex of the new input to the corresponding Thr1_Obj sub-object.

The following table outlines the object mapping parameters for the Throttle application. Each object in the table represents a specific function or control point within the application, and the corresponding CANOpen index and subindex define where these objects are located in the CANOpen network. By configuring these parameters, users can tailor the Throttle application to their specific needs, ensuring precise control and monitoring of various functions.

By correctly configuring these object mappings, users can ensure that the Throttle application communicates accurately with the various inputs and outputs connected to the emDrive. This flexibility allows for precise control of throttle, brake, pump, and other critical functions, enhancing the overall performance and reliability of the system.

2.1 Examples

2.1.1. Configuring an object to be used in in the application (e.g. for Thr1_Obj__ThrottleVoltage)

All mapping of object to the application are done in the same way. For relays (digital outputs), switches (digital inputs), torque & velocity reference,... The main point is to show that you need to combine index and subindex of the object you want to use in your throttle application.

For example, to map the throttle voltage input to the emDrive analog input 1 (which has a CANOpen object HW_AIN_AIN1 with index 0x3090 and subindex 0x01 as shown in the picture bellow), you would write 0x309001 to Thr1_Obj__ThrottleVoltage.
To read if the correct value is written you need to use the HEX value (black circle).

3. How to Use Each Module

3.1 Initial Setup Assumptions

This document assumes that the angle sensor calibration has already been completed by the user, and that all other emDrive parameters for the motor and regulation have been properly configured. Before using any module we have to enable the CANOpen object Thr1_enable with index 0x4010 and subindex 0x00, for that we have to write 1 to the "value" field.

4010 - Thr1_enable = 1

3.2 Pre-charge Module

The Pre-charge module limits the charging current of the emDrive capacitors by activating the pre-charge relay switch before the main relay switch is engaged. The pre-charge relay switch has a resistor connected in series, which limits the current during the capacitor charging phase.

Note that the main and pre-charge relay switches are not integrated within the emDrive and must be provided externally. For more details, refer to section 5.4 of the EmDrive user manual.

For readability and clarity, the following abbreviations are used:

• The pre-charge relay switch refers to Thr1_Obj__PrechargeRelayEnableDO
  
• The main relay switch refers to Thr1_Obj__MainRelayEnableDP

The sequence begins with the activation of the pre-charge relay switch. After the duration specified by the Thr1_Precharge__PrechargeTime parameter (default is 2 seconds), the drive voltage is checked. If the voltage does not exceed the threshold set by the Thr1_Precharge__MinDC_Voltage parameter, an error state is reported. If the voltage is above this threshold, the main relay switch is activated. Finally, after the time specified by the Thr1_Precharge__DelayBeforePrechargeOff parameter has elapsed, the pre-charge relay switch is turned off, and the run state is set to true, activating the throttle and brake functionality. Additionally, we have a diagram illustrating the above functionality. It is assumed that after the pre-charge time, the DC voltage exceeds the set threshold, thus no error state is encountered.

To set this module you have to set all of the objects in table 3 and also use the correct mapping for Thr1_Obj__PrechargeRelayEnableDO and Thr1_Obj__MainRelayEnableDP.

You can also verify whether the pre-charge completed successfully or if an error occurred using the pre-charged module signals.

The module also allows configuration of the precharge module to compare the DC link voltage measured on the inverter with the actual voltage of the battery. It will turn on the main relay only when the voltage difference is less than the threshold specified by Thr1_Precharge__AllowedVoltageDifference (this needs to happen before the Thr1_Precharge__PrechargeTime). An example of this configuration can be found under "Pre-charge Example 2".

3.2.1 Examples

- Pre-charge example 1

Description:
In this example, we will use the precharge module. For this, we need two relays: the main relay and the precharge relay. We also need to determine the voltage threshold for activating the main relay and the correct timings, which are described in Section 3.2.

Relay Connections
Main Relay: Connected to HW_LS1 = 0x30A0 0x02
Precharge Relay: Connected to HW_LS2 = 0x30A1 0x02
Voltage Measurement
The voltage will be measured using the inverter, which is the standard method (0x3101 0x07 Udc).

Timings
Precharge Time: 2 seconds
Time After Precharge Relay Turns Off: 0.5 seconds
Voltage Threshold
The voltage threshold for activating the main relay is 24V.

Objects to set:

1. 1. Enable Throttle Application:
      
      0x4010 - Thr1_enable = 1
      
   2. Enable the Precharge Module:
      
      Use the throttle general object 0x4011 Thr1_Gen to enable the proper module.
      
      0x4011 0x06 Precharge = 1
      
   3. Map Objects to the Application:
      
      Choose the proper digital outputs to control the main relay and precharge relay:
      
      e.g:
      As per description we have the main relay connected to HW_LS1 and the precharge relay connected to HW_LS2. The object indexes are as follows:
      
      HW_LS1 = 0x30A0 0x02
HW_LS2 = 0x30A1 0x02
      
      We set the following:
      
      0x4012 0x14 MainRelayEnableDO = 0x30A002
0x4012 0x15 PrechargeRelayEnableDO = 0x30A102
      
      Voltage that is measured can be set but it is recommended to use default (0x3101 0x07 Udc), to change the object use the following:
      
      0x4012 0x16 PrechargeDC_Voltage = 0x310107
      
      
2. Configure the Precharge Module:
   
   Set the precharge time:
   
   0x4016 0x01 PrechargeTime = 2
   
   Set the time after the precharge relay is turned off:
   
   0x4016 0x02 DelayBeforePrechargeOff = 0.5
   
   Set the minimum voltage that must be present:
   
   0x4016 0x03 MinDC_Voltage = 24
   
   
3. Save and Reset:
   
   Save the settings (Ctrl+S) and perform a reset.
   Switch to operational mode.
   Test
   Enable auto start if everything works correctly (inverter will always go to operational mode after reset).
   
   0x3000 0x03 AutoStart = 1

- Pre-charge example 2

Description:
In this example, we will use the precharge module, to enable the min relay when the difference between the DC - link on the inverter and the battery voltage is les then the threshold set in Thr1_Precharge__AllowedVoltageDifference

For this example, you need to first finish the Pre-charge example 1 and then continue with the following steps.

First you need to use the PDOs to get the value of the battery and map it to one of the 0x3020 - General_Purpose objects.
In this example the voltage value of the battery is sent to 0x3020 0x09 - General_Purpose__gen1_32bit.

First you need to map the object where the value if the battery is stored:
0x4012 0x17 - PrechargeBatteryVoltage = 0x302009

Next you need to set allowed difference between DC-link that is measured on the inverter and the voltage of the battery.
Lets say that the voltage difference can be 10V.
0x4016 0x04 - AllowedVoltageDifference = 10V

If the actual voltage difference is more than 0x4016 0x04 - AllowedVoltageDifference = 10V, after the period specified in Thr1_Precharge__PrechargeTime an error is raised.

3.3 Throttle module

The throttle module is responsible for calculating the desired output torque based on the given input voltage. It provides features such as short to ground and short to power supply detection, reading forward and reverse switches, rate-limiting the output, and disabling the throttle when the brake is active. Below is a detailed guide on the state diagram and parameter settings for the throttle module.

3.3.1 State Diagram

The state diagram for the throttle module consists of several states and transitions, ensuring the correct operation and safety of the system.

Startup State

• Buzzer Activation: Upon system start, the buzzer is activated if an external buzzer is connected.
• Wait Time: The system waits for the duration specified by the parameter Thr1_Timing__WaitAfterStart to complete the startup.
• Error Check: If an error is detected during startup, the system transitions directly to the Error State.

Operational State

• Buzzer Deactivation: The buzzer is disabled upon entering the operational state.
• RPM Check: The system waits for the RPM to drop to 0, if it is not already there.
• Bridge Disable: The bridge is disabled, and the system waits for the throttle to be set to zero.

Idle State

• Idle Mode: The system enters the Idle State, waiting for the input to move out of the zero position.

Driving State

• Throttle Enabled: If the input moves out of the zero position and the throttle is enabled, the system transitions to the Driving State.
• Bridge Enable: The bridge is enabled, and the output is forwarded to motor control.

WaitForNeutral State

• Throttle Disabled: If the throttle is disabled and the output moves out of the zero position, the system returns to the WaitForNeutral State.

WaitForSpeedDrop State

• Output Set to 0: When the throttle is disabled during the Driving State (either due to Thr1_Enable__Throttle being set to 0, input within the disable dead band, or outside allowed values), the system enters the WaitForSpeedDrop State.
• RPM Check: The output is set to 0, but the bridge remains enabled until the RPM drops below the value specified by Thr1_Brake__Full_RPM.
• Wait Time: The system waits for the time configured in Thr1_Timing__WaitBeforeBridgeDisable.
• State Transition: The state changes to Idle or WaitForNeutral based on whether the input is at zero or not.

Charging State

• RPM Drop: If charging is detected during the operational state, the system waits for the RPM to drop.
• Bridge Disable: The system moves to the Charging State, where the bridge is disabled.
• Return to Operational: When charging is no longer detected, the system returns to the operational state.

Error State

• Error Detection: If an error is detected in any state, the system transitions to the Error State.
• Bridge Disable: The bridge is disabled, and the buzzer is activated.
• RPM Check: In case of an error during the operational state, the system waits for the RPM to drop before disabling the bridge.
• Priority to Error State: If both charging and an error are detected simultaneously, the system prioritizes transitioning to the Error State.
• System Reset: There is no automatic recovery from the Error State; the system must be manually reset.

3.3.2 Input to Output Transformation

The input to output transformation converts the input voltage of the analog input to output torque, which is forwarded to motor control if the throttle is enabled. The basic transformation is illustrated in the graph below.

• Thr1_Throttle__ZeroValue: Defines the zero point of the input.
• Thr1_Throttle__ZeroDeadBand: Defines the dead band around the zero point. While the input voltage is within this dead band, the output remains zero.
• Thr1_Throttle__MinInput: Minimum valid input voltage.
• Thr1_Throttle__MaxInput: Maximum valid input voltage.
• Thr1_Throttle__OutFullPositive: Maximum positive output torque.
• Thr1_Throttle__OutFullNegative: Maximum negative output torque.
• Thr1_Throttle__NonValidMin: Minimum input voltage considered valid.
• Thr1_Throttle__NonValidMax: Maximum input voltage considered valid.

The transformation includes the following regions:

• Zero Dead Band:

  • Defined by Thr1_Throttle__ZeroValue and Thr1_Throttle__ZeroDeadBand.
  • Output remains zero when input voltage is within the dead band.

• Positive Torque Region:

  • From the end of the dead band to Thr1_Throttle__MaxInput, the output rises in the positive direction from 0 to Thr1_Throttle__OutFullPositive.
  • Output is calculated as y=x^a​ , where $y$ is the normalized output (0 at 0 and 1 at Thr1_Throttle__OutFullPositive), $x$ is the normalized input (0 at the edge of the dead band and 1 at Thr1_Throttle__MaxInput), and $a$ is the parameter Thr1_Throttle__Progressive, which ranges between 0.3 and 3. The default value for $a$ is 1, indicating a linear growth of output torque.

• Negative Torque Region:

  • From the end of the dead band to Thr1_Throttle__MinInput, the output falls in the negative direction.
  • Output is calculated as y=−∣x∣^a

• Constant Max Torque Region:

  • Between Thr1_Throttle__MaxInput and Thr1_Throttle__NonValidMax, the output remains at maximum positive torque.
  • Between Thr1_Throttle__MinInput and Thr1_Throttle__NonValidMin, the output remains at maximum negative torque.
  • If the input value increases beyond Thr1_Throttle__NonValidMax or decreases beyond Thr1_Throttle__NonValidMin, the output torque is set to 0 and the throttle module enters the error state.

This transformation ensures that the throttle application accurately converts the input voltage into the appropriate output torque for motor control, with safeguards in place to handle invalid input values and prevent unintended behaviour.

3.3.3 Other throttle module functions

Enable dead band

Enable Dead Band functions similarly to Zero Dead Band. However, instead of setting the throttle output to 0, it disables the driver bridge when the input is less than a specified distance from the zero point. This distance is determined by the Enable Dead Band threshold. To disable Enable Dead Band, set its value to 0.

Ensure this threshold is always smaller than the Zero Dead Band threshold to prevent unusual behaviour.

Disable at brake

When the parameter 0x4013 0x0E DissableAtBrake is set to 1, the throttle module output is set to zero whenever the brake is active. This means that as soon as the brake is applied, the EmDrive system will start braking immediately, regardless of the throttle input.

When the parameter 0x4013 0x0E DissableAtBrake is set to 0, the throttle and brake outputs are combined before being sent to motor control. In this case, the EmDrive system will only start braking if the brake output is greater than the throttle output.

Rate limit

The rate limit controls how quickly the output can change in response to changes in the input (Higher the number, faster the change). This is determined by the parameter 0x4013 0x0A RateLimit.

When the input changes from 0 to 1 (works on normed value), the output will change from 0 to 1 in 1 / RateLimit seconds.

Output of throttle at zero value

If the application needs a specific output (not zero) to be set at zero position of a potentiometer 0x4013 0x01 ZeroValue, the object 0x4013 0x0D OutZero can be set to achieve this functionality. This will be presented in Throttle example 4. 
With this feature the 0x4013 - Thr1_Throttle__EnableDeadBand, should be disabled

3.3.4 Examples

- Throttle example 1

Description:
Monodirectional throttle using only one analog input.

In this example, we will use a potentiometer as our throttle input. Our goal is to control the motor in velocity mode, ranging from 0 to 100 RPM.

Throttle Input Details
Potentiometer: Used as the throttle input. Connected to AIN3 = 0x3090 0x03
Voltage and RPM Control
Error Condition: If the voltage from the potentiometer is lower than 0.2V or higher than 4.8V, an error will occur (indicating a possible short or broken connection).
0 RPM: At 0.5V, the motor should run at 0 RPM.
100 RPM: At 4.5V, the motor should run at the maximum speed of 100 RPM.

Objects to set:

1. 1. Enable Throttle Application:
      
      0x4010 - Thr1_enable = 1
      
   2. Enable the Throttle Module:
      
      Use the throttle general object 0x4011 Thr1_Gen to enable the proper module.
      
      0x4011 0x01 Throtle = 1
      
      
   3. Map Objects to the Application:
      
      Choose the reference value to control (velocity or torque) and map analog/digital inputs and outputs.
      
      To control velocity:
      
      0x4012 0x06 TargetObj = 0x301005
      
      To control torque:
      
      0x4012 0x06 TargetObj = 0x301004
      
      Set the control mode (0 for torque, 1 for velocity):
      
      0x3100 0x01 ControlMode = 0 or 1
      
      Define the analog throttle input (potentiometer on AIN3):
      
      0x4012 0x03 ThrottleVoltage = 0x309003
      
      
      
   4. Configure the Throttle Module:
      
      Set the throttle voltage parameters as  explained in Section 4.2:
      
      0x4013 0x01 ZeroValue = 0.5
0x4013 0x04 MaxInput = 4.5
0x4013 0x05 MinInput = 0.5
0x4013 0x06 NonValidMax = 4.8
0x4013 0x07 NonValidMin = 0.2
      
      Set the maximum and minimum TorqueRef or VelocityRef:
      In this example we will use max = 100rpm and min = 0rpm
      
      0x4013 0x0B OutFullPositive = 100
0x4013 0x0C OutFullNegative = 0
      
      
      
   5. Save and Reset:
      
      Save the settings (Ctrl+S) and perform a reset.
      Switch to operational mode.
      Test
      Enable auto start if everything works correctly (inverter will always go to operational mode after reset).
      
      0x3000 0x03 AutoStart = 1
      
      
      

- Throttle example 2

Description:

In this example, we will use the same potentiometer as in Throttle Example 1. The main difference is that this setup allows for bidirectional control of the throttle. Here’s how it works:

• At 2.5V, the motor will be at 0 RPM.
• At 4.5V, the motor will run at 100 RPM.
• At 0.5V, the motor will run at -100 RPM (in reverse).

This setup enables you to control the motor speed and direction using a single analog input.

Objects to set:

1. 1. Same as example "Throttle example 1"
   2. Same as example "Throttle example 1"
   3. Same as example "Throttle example 1"
   4. Configure the Throttle Module:
      Set the throttle voltage parameters as  explained in Section 4.2:
      
      0x4013 0x01 ZeroValue = 2.5
0x4013 0x04 MaxInput = 4.5
0x4013 0x05 MinInput = 0.5
0x4013 0x06 NonValidMax = 4.8
0x4013 0x07 NonValidMin = 0.2
      
      Set the maximum and minimum TorqueRef or VelocityRef:
      In this example we will use max = 100rpm and min = -100rpm
      
      0x4013 0x0B OutFullPositive = 100
0x4013 0x0C OutFullNegative = -100
      
      Additionaly we have to set IsNegativeBrake 

0x4013 0x11 IsNegativeBrake = 0
      
      
   5. Same as example "Throttle example 1"
      
      
      

- Throttle example 3

Description:
In this example, we will use the same potentiometer as in Throttle Example 1, along with two additional digital inputs to control the motor's direction. 

Digital input 1 = 0x30B0 0x01 DIN1 - enable/disable positive throttle
Digital input 2 = 0x30B0 0x02 DIN2 - enable/disable negative throttle.

Objects to set:

1. 1. Same as example "Throttle example 1"
   2. Same as example "Throttle example 1"
   3. Same as example "Throttle example 1"
   4. Same as example "Throttle example 1"
      
      Additionally, we only need to map digital input objects for enabling forward/reverse throttle.
      
      e.g.
      We will use object 0x30B0 0x01 - DIN1 to enable/disable positive throttle.
      We will use object 0x30B0 0x02 - DIN2 to enable/disable negative throttle.
      
      So we need to set:
      
      0x4012 0x04 ThrottleFWD_Dlvalue = 0x30b001
0x4012 0x05 ThrottleREW_Dlvalue = 0x30b002
      
      If DIN1 and DIN2 are the same value, the throttle will not work. Only one of them can be 1 and the other 0.
      
      

      Currently the inverter does not support using only one physical input (e.g switch) to change direction. There must be two of them!
      

      
      Additionaly we have to set IsNegativeBrake 

0x4013 0x11 IsNegativeBrake = 0
      
      
   5. Same as example "Throttle example 1"

- Throttle example 4

Description:
In this example, we will need a working "Throttle example 1", the main difference will be that at 0.5V we want 100RPM and then we want to ramp up do the max value of 200 RPM.
We also want to have an ignition switch (enable switch). Which will be connected to 0x30B0 0x01 - DIN1 

We need to set the OutFullPositive = MAX desired RPM - OutZero 

0x4013 0x0B - OutFullPositive = 100
0x4013 0x0D - OutZero = 100 

With these settings you can try the application, where you will see that you can never disable the motor. If you go to the min position of the potentiometer the motor will spin with 100 RPM.

Setting the switch:
Currently there is a workaround to have an ignition switch which will be changed in the future official release.
To get the ignition switch working we need to map the 0x30B0 0x01 - DIN1 to ThrottleFWD_Dlvalue

0x4012 0x04 - ThrottleFWD_Dlvalue = 0x30B001
0x4012 0x05 - ThrottleREW_Dlvalue = 0x302001 This is the workaround we map the 0x3020 0x01 - gen1_8bit to the throttle application. This value shall be always at default = 0.

If the throttle potentiometer is in any position other than at 0 e.g. at motor spins at 140RPM and you disable the ignition switch, the motor will stop spinning. But if you then start ignition again it will go directly to the rpm that are set with throttle (in this example back to 140RPM). You need to put the throttle to min.

With this workaround only monodirectional throttle + ignition will work. In the future FW release, there will be a new object for ignition/enable and it will work also in bidirectional throttle.
The protection will also be implemented so that it does not spin out of control.

3.4. Brake module

The brake module implements the brake function within the throttle application, operating similarly to the throttle module but with a crucial difference: it always outputs torque in the opposite direction of the current rotation and supports only monodirectional braking. The brake can be assigned to a different analog input or share the same analog input as the throttle module, beneficial for configurations where monodirectional throttle is used. In such cases, one direction from the zero point can manage throttle control while the other handles brake control.

3.4.1 Input to Output Transformation

The input to output transformation functions in a similar manner to the input-output transformation of the throttle module. A typical example of this transformation is illustrated in the picture below.

The type of slope between the end of the zero dead band and Thr1_Brake__MaxInput is determined by the parameter Thr1_Brake__Progressive, similar to how it is for the throttle module. Additionally, the brake module can be configured to increase brake torque when the input decreases. This can be achieved by setting the parameter Thr1_Brake__MaxInput to a value smaller than Thr1_Brake__ZeroValue. The resulting input to output transformation for this configuration is illustrated in the picture below.

For both modes, it is essential to configure the parameters Thr1_Brake__NonValidMax and Thr1_Brake__NonValidMin. Failing to do so will result in incorrect operation of the short to ground and short to power supply error detection.

3.4.2 Examples

To use the brake module, you first need to configure the throttle module and ensure it works as expected.

- Brake example 1

Description:
Monodirectional throttle & brake using only one analog input.
In this example, a potentiometer is used to adjust voltage from 0V to 5V. The operational range is 0.2V to 4.8V. If the voltage goes outside this range, an error occurs.

Throttle and Brake Operation
Neutral Position: At 2.5V, the motor is in neutral.
Increasing Voltage: Raising the voltage above 2.5V speeds up the motor.
Decreasing Voltage: Lowering the voltage below 2.5V brakes the motor.

Before proceeding with this example, ensure you have completed and prepared a working setup of "Throttle Example 1" with torque control, not velocity. To achieve this, configure the following settings:

• Set Target Object: 0x4012 0x06 TargetObj = 0x301004
• Set Control Mode: 0x3100 0x01 ControlMode = 0
  

Objects to set:

1. Enable Throttle Application:
   
   0x4010 - Thr1_enable = 1
   
2. Enable the Throttle & Brake Module:
   
   0x4011 0x03 Throtle = 1 0x4011 0x04 Brake = 1
   
   
3. Map Objects to the Application:
   
   Torque control
   
   0x4012 0x06 TargetObj = 0x301004
   
   Check that torque mode is active if not set it with control mode = 0:
   0x3100 0x01 ControlMode = 0
   
   Define the analog throttle input (e.g., potentiometer on AIN3):
   
   0x4012 0x03 ThrotleVoltage = 0x309003
   
   Define the analog brake input (same as ThrotleVoltage in this example):
   
   0x4012 0x12 BrakeVoltage = 0x309003
   
   
   
4. Configure the Throttle Module:
   
   Set the throttle voltage parameters as  explained in Section 4.2:
   
   0x4013 0x01 ZeroValue = 2.5
0x4013 0x04 MaxInput = 4.5
0x4013 0x05 MinInput = 0.5
0x4013 0x06 NonValidMax = 4.8
0x4013 0x07 NonValidMin = 0.2
   
   Set the maximum and minimum TorqueRef 
   In this example we will use max = 10Nm and min = 0Nm (if there is no load) - BIDIRECTIONAL throttle must be dissabled (one of these must be 0) for using only one analog input as throttle and brake.
   
   0x4013 0x05 OutFullPositive = 10
0x4013 0x05 OutFullNegative = 0
   
   
   
5. Configure the Brake Module:
   
   Set the brake voltage parameters:
   
   0x4014 0x01 ZeroValue = 2.5
0x4014 0x04 MaxInput = 0.5
0x4014 0x05 NonValidMax = 4.8
0x4014 0x06 NonValidMin = 0.2 0x4014 0x09 OutFull = 10
   
   
   
6. Save and Reset:
   
   Save the settings (Ctrl+S) and perform a reset.
   Switch to operational mode.
   Test
   Enable auto start if everything works correctly (inverter will always go to operational mode after reset).
   
   0x3000 0x03 AutoStart = 1

- Brake example 2

Description:

In this example, we will use two analog inputs to control the motor:

• Analog Input 1: Controls the throttle (motor speed).
• Analog Input 2: Controls the brake.

This setup allows you to manage both the acceleration and deceleration of the motor independently using separate analog inputs.

Objects to set:

1. Same as "Brake example 1"
2. Same as "Brake example 1"
3. Map Objects to the Application:
   
   Torque control
   
   0x4012 0x06 TargetObj = 0x301004
   
   Check that torque mode is active if not set it with control mode = 0:
   0x3100 0x01 ControlMode = 0
   
   Define the analog throttle input (e.g., potentiometer on AIN3):
   
   0x4012 0x03 ThrotleVoltage = 0x309003
   
   Define the analog brake input (e.g., potentiometer AIN2):
   
   0x4012 0x12 BrakeVoltage = 0x309002
   
   
   
4. Configure the Throttle Module:
   
   Set the throttle voltage parameters as  explained in Section 4.2:
   
   0x4013 0x01 ZeroValue = 0.5
0x4013 0x04 MaxInput = 4.5
0x4013 0x05 MinInput = 0.5
0x4013 0x06 NonValidMax = 4.8
0x4013 0x07 NonValidMin = 0.2
   
   Set the maximum and minimum TorqueRef 
   In this example we will use max = 10Nm and min = 0Nm (if there is no load) - BIDIRECTIONAL throttle must be dissabled (one of these must be 0) for using only one analog input as throttle and brake.
   
   0x4013 0x05 OutFullPositive = 10
0x4013 0x05 OutFullNegative = 0
   
   
   
5. Configure the Brake Module:
   
   Set the brake voltage parameters:
   
   0x4014 0x01 ZeroValue = 0.5
0x4014 0x04 MaxInput = 4.5
0x4014 0x05 NonValidMax = 4.8
0x4014 0x06 NonValidMin = 0.2 0x4014 0x09 OutFull = 10
   
   
   
6. Same as "Brake example 1"
   
   
   

3.5. Pump control module

The Pump Control Module manages the operation of two pumps in the system: the main pump and the cooling pump.

• The main pump is activated whenever the throttle application is in the run state or when the cooling pump is active.
• The cooling pump is regulated by a simple hysteresis controller.

Activation: The cooling pump turns on if the temperature exceeds the threshold set in the Thr1_Pump__OnTemperature parameter.
Deactivation: The cooling pump turns off if the temperature drops below the threshold set in the Thr1_Pump__OffTemperature parameter.

3.5.3 Examples

- Pump example 1

Description:

In this example we will control two pumps: main pump and cooling pump.

Main pump on LS3 0x30A2 0x02 Value  
Cooling pump on LS4 0x30A3 0x02 Value
Temperature at which we start the pump = 50 °C
Temperature at which we stop the pump = 60 °C

Objects to set:

1. Enable Throttle Application:
   
   0x4010 - Thr1_enable = 1
   
2. Enable the Pump Module:
   
   0x4011 0x03 Pump = 1
   
   
3. Map Objects to the Application:
   
   For this module the CoolingInputTemperature1 and CoolingInputTemperature2 are set by default. 
   Ctrl_Bridge__StatusHeatsinkTemp is mapped to CoolingInputTemperature1
Ctrl_Gen_Stat__MotorSensorTemp is mapped to CoolingInputTemperature2

0x4012 0x0D CoolingInputTemperature1 = 0x31CE00 
0x4012 0x0E CoolingInputTemperature2 = 0x31010A
   
   Next we need to map the digital outputs where our pumps are connected to. In this example we will use:
   Main pump on LS3 0x30A2 0x02 Value  
   Cooling pump on LS4 0x30A3 0x02 Value

0x4012 0x0B MainPumpEnableDO = 0x30A202
0x4012 0x0C CoolingPumpEnableDO = 0x30A302
   
   
   
   
4. Configure the Pump Module:
   
   Set the temperature at which the pump starts and stops.
   
   0x4015 0x01 OnTemperature = 60
0x4015 0x02 OffTemperature = 50
   
   
5. Save and Reset:
   
   Save the settings (Ctrl+S) and perform a reset.
   Switch to operational mode.
   Test
   Enable auto start if everything works correctly (inverter will always go to operational mode after reset).
   
   0x3000 0x03 AutoStart = 1
   
   

3.6. DC-DC turn on delay module

DC-DC turn on delay module enables an external DC-DC module with a delay after start-up. The delay time 
can be configured by setting parameter Thr1_DCDC__StartupDelay

3.6.1 Examples

- DC-DC delay example 1

The relay is connected to LS2 0x30A1 0x02 Value  
DC-DC turn on delay set to 5s.

Objects to set:

1. Enable Throttle Application:
   
   0x4010 - Thr1_enable = 1
   
2. Enable the DC-DC Module:
   
   0x4011 0x07 DC_DC = 1
   
   
3. Map Objects to the Application:
   
   DC-DC relay is on LS2 0x30A1 0x02 Value

0x4012 0x0F DCDCenableDO = 0x30A102
   
   
   
4. Configure the DC-DC Module:
   
   Set the delay to 5s
   
   0x4017 0x00 Thr1_DCDC__StartupDelay = 5
   
   
5. Save and Reset:
   
   Save the settings (Ctrl+S) and perform a reset.
   Switch to operational mode.
   Test
   Enable auto start if everything works correctly (inverter will always go to operational mode after reset).
   
   0x3000 0x03 AutoStart = 1

3.7. SOC monitoring and charging detection module

The SOC (State of Charge) monitoring module and the charging detection module are implemented together due to their similarities. However, both modules can be enabled and disabled independently. SOC monitoring requires a Battery Management System (BMS) to detect SOC. Note that the BMS is not included in the emDrive. If SOC monitoring is needed, an independent BMS must be connected to the CAN bus.

3.7.1 SOC Monitoring Module

The SOC monitoring module tracks the SOC state as reported by the BMS.

• Behaviour:

  • If SOC drops below the level specified by the parameter Thr1_Bat__StartLimitingSOC, the module will start limiting the maximum output torque.
  • If SOC falls below the level specified by Thr1_Bat__EndLimitingSOC, the maximum torque output will be set to the value given in Thr1_Bat__EndLimitingThrottleOut.
  • When SOC is between Thr1_Bat__StartLimitingSOC and Thr1_Bat__EndLimitingSOC, the maximum torque is linearly reduced. The reduction goes from the maximum torque (as defined in the throttle module) at Thr1_Bat__StartLimitingSOC to the torque defined in Thr1_Bat__EndLimitingThrottleOut at Thr1_Bat__EndLimitingSOC.
    
    
    
    
    
    

• Throttle Limiting Speed:

  • Controlled by the parameter Thr1_Bat__ThrottleLimitRamp.
  • The limiting speed functions similarly to rate limiting in the throttle and brake modules, where throttle limiting can range from 0 to 1 in 1/Thr1_Bat__ThrottleLimitRamp seconds.

3.7.2 Charging detection Module

The charging detection module monitors whether the battery is being charged and reports this status to the throttle module.

• Behaviour::
  • If a BMS is present, the module queries the BMS to check if the battery is currently being charged.
  • Alternatively, the module can observe the state of the input mapped to the parameter Thr1_Obj__ChargingDetectDIvalue:
    • If the value is 1, the battery is considered to be charging.
    • If the value is 0, the battery is considered to be not charging.

This setup allows for accurate monitoring and management of the battery's state of charge and charging status, ensuring optimal performance and safety.

3.7.3 Parameters and signals overview

3.7.4 Examples

- SOC example 1

Description:
In this example we first need a working example of Throttle module to control torque. (It is also possible to control velocity.)
Next we need the following values:

• Battery (BMS) calie/present
• SOC in percent
  

To achive this we can use the PDOs to get the values - in this example we will assume that we get the upper values via CAN and we set the values to our 0x2051 Customer_Data_16bit__Value. How to configure the PDOs refer to the user manual section 9.4-Data transfer – Process Data Object (PDO).

Battery (BMS) calie/present needs to be higher than 0, otherwise inverter thinks there is no BMS.

0x2051 0x01 Customer_Data_16bit__Value1 = Battery (BMS) calie/present (needs to be higher than 0)
0x2051 0x02 Customer_Data_16bit__Value2 = SOC in percent


We will start limiting the output when the battery has SOC = 10%
We will limit the output with a ramp of value 0.01 until we reach SOC = 5%, after which we stay at value 10Nm (in case of velocity control the unit of this value will be in PRM - 10RPM).

Objects to set:

1. 1. Enable the SOC Module:
      
      Use the throttle general object 0x4011 Thr1_Gen to enable the proper module.
      
      0x4011 0x08 SOC = 1
      
   2. Map Objects to the Application:
      
      As mentioned above we have the required date on the Costomer_Data_16bit_Values.
      
      Customer_Data_16bit__Value1 = 0x2051 0x01
Customer_Data_16bit__Value2 = 0x2051 0x02
      
      We set the following:
      
      0x4012 0x07 BatValid = 0x205101
0x4012 0x08 BatSOC = 0x205102
      
      
      
      
2. Configure the SOC Module:
   
   Set at what SOC percent we start limiting the output (at 10 %):
   
   0x4018 0x01 StartLimitingSOC = 10
   
   Set at what SOC percent we stop limiting the output (at 5 %):
   
   0x4018 0x02 EndLimitingSOC = 5
   
   Set what will the max value output be at the value EndLimitingSOC   (10Nm): 
   
   0x4018 0x03 EndLimitingThrotleOut = 10
   
   Set the ramp parameter for slope:
   
   0x4018 0x04 ThrotleLimitRamp = 0.01
   
   
   
3. Save and Reset:
   
   Save the settings (Ctrl+S) and perform a reset.
   Switch to operational mode.
   Test
   Enable auto start if everything works correctly (inverter will always go to operational mode after reset).
   
   0x3000 0x03 AutoStart = 1
   
   
   

- Charging detection example 2

Description:
You need a working throttle example.
As mentioned above we can detect charging with the state that is reported by BMS for that we need to get the state of the BMS in this example we will use method as in SOC example 1, where use the PDOs and save the state to Costomer_Data_16bit_Value.


Customer_Data_16bit__Value1 = 0x2051 0x01 = Battery (BMS) Valid/present (needs to be higher than 0)
Customer_Data_16bit__Value3 = 0x2051 0x03 = State of BMS

Objects to set:

1. 1. Enable the SOCModule and ChargingDetect Module:
      
      Use the throttle general object 0x4011 Thr1_Gen to enable the proper module.
      
      0x4011 0x08 SOC = 1
0x4011 0x09 ChargingDetect = 1
      
   2. Map Objects to the Application:
      
      As mentioned above we have the required date on the Costomer_Data_16bit_Values.
      
      Customer_Data_16bit__Value1 = 0x2051 0x01
Customer_Data_16bit__Value3 = 0x2051 0x03
      
      We set the following:
      
      0x4012 0x07 BatValid = 0x205101
0x4012 0x09 BatState = 0x205103
      
      
      
2. Configure the ChargingDetect Module:
   
   With this module there is no other configuration needed. If the value on Customer_Data_16bit__Value3 == (charge = 4) or (charge_done = 5) -> driving is disabled. 
   
   
   
3. Save and Reset:
   
   Save the settings (Ctrl+S) and perform a reset.
   Switch to operational mode.
   Test
   Enable auto start if everything works correctly (inverter will always go to operational mode after reset).
   
   0x3000 0x03 AutoStart = 1

- Charging detection example 3

Description:
You need a working throttle example.
The next method is to detect charging with a digital input, for that we will use digital input 4.

0x30B0 0x04 DIN4

Objects to set:

1. 1. Enable the SOCModule and ChargingDetect Module:
      
      Use the throttle general object 0x4011 Thr1_Gen to enable the proper module.
      
      0x4011 0x08 SOC = 1
0x4011 0x09 ChargingDetect = 1
      
   2. Map Objects to the Application:
      
      As mentioned above we have the required date on the Costomer_Data_16bit_Values.
      
      Customer_Data_16bit__Value1 = 0x2051 0x01
DIN4 = 0x30B0 0x04
      
      We set the following:
      
      0x4012 0x07 BatValid = 0x205101
0x4012 0x0A ChargingDetectDlvalue = 0x30B004
      
      
      
2. Configure the ChargingDetect Module:
   
   With this module there is no other configuration needed. If the value of DIN4 == 1 -> driving is disabled. 
   
   
   
3. Save and Reset:
   
   Save the settings (Ctrl+S) and perform a reset.
   Switch to operational mode.
   Test
   Enable auto start if everything works correctly (inverter will always go to operational mode after reset).
   
   0x3000 0x03 AutoStart = 1