Test a script outside Profinity

profinity-script creates a script on a developer machine and runs it against a simulated Profinity, before the script file is copied into a profile. The tool ships in the Profinity SDK download, in its profinity-script folder, and not with the Profinity install. This page calls the downloaded SDK the kit. On Windows the program is profinity-script.exe. The kit also contains the Component Pack CLI (profinity-component-pack) and the Profinity.Sdk package. The package on its own does not create or run a script. The SDK is licensed separately. Refer to Licensing. For a copy of the SDK, contact Prohelion.

The simulator does not start Profinity and does not need a CAN bus. It calls the script the way Profinity does, and the script calls the same Profinity object. Once the script is in a profile it needs the Scripting feature, which a Desktop, Server, or Enterprise licence includes. Refer to Profinity Scripting.

A C# project in a generated folder references Profinity.Sdk. To let the editor complete Profinity types, add the kit folder that contains that package as a local NuGet source. profinity-script sim compiles and runs the script itself. If a project still references Profinity.Component.Sdk, change that reference to Profinity.Sdk.

Create a runnable script

Python and Lua need only profinity-script. Run the following commands from the kit's profinity-script folder. With no arguments, profinity-script runs sim in the current directory.

Create a runnable Python script.
```
profinity-script new runnable --language python
```
The command writes a folder named runnable and prints its path. --language accepts python, lua, or csharp, and it defaults to python.
Change into that folder.
```
cd runnable
```
Run the simulator.
```
profinity-script sim
```
The command prints ran and exits with no error message. That line is what script.py writes with Profinity.Console.WriteLine.
```
ran
```

profinity-script sim runnable, run from the profinity-script folder, does the same thing without changing directory.

The simulator reads sim.yaml, which sits next to the script, runs the script, and prints the lines the script writes to the console. A script that only stores a tag or a setting prints nothing, and the run has still worked when the command exits with no error message. Add Profinity.Console.WriteLine to see a stored value. The command does not print tags, settings, notifications, or CAN frames on its own. To run a tag-change, receiver, service, alert, firmware-load, or prompt script, create it from the matching template and edit sim.yaml. Refer to profinity-script reference for the templates and every sim.yaml key.

Copy the script into a profile

When the console lines are right, copy the script file into the profile. Leave sim.yaml on the developer machine. Profinity runs the copied file.

Add a script component as described in How to write your first script. A script that belongs to a Custom Component goes in that component, under the name the component already uses.
Review the script before it is enabled. A script in a profile runs with the same operating system permissions as Profinity.

For what a script can do in a profile, refer to Profinity Scripting. If the command fails, or the simulator cannot cover a call the script makes, refer to the errors and the limits of the simulator in the profinity-script reference.