OpenVSM documentation

Introduction

OpenVSM is a model sumulation engine with C and Lua API for Proteus 7/8 CAD Written in C and gcc-ready (mingw/cygwin) for Linux and Windows

• You can create your model as standalone DLL or use DLL and Lua script together
• Function prototypes have the same syntax in both API
• Designed with hope to make simulation as simple as possible for electronics enthusiasts Visit 'example' directory for sample project files

Installation

• Install mingw32 for you platform and add its directory to PATH environment variable
• Clone https://github.com/Pugnator/openvsm.git
• Change to the cloned directory

Windows users

• Issue

  mingw32-make

  You can change the name of resulted dll:

  mingw32-make OPENVSMLIB=test

• Copy lua53/lua.dll to %windir%\system32 directory
• Create environment variable containing path to the script directory:

  setx LUAVSM "C:\script\"

Linux users (DLL build only)

• Issue

  make

  or

  make OPENVSMLIB=test

  in case you want to change the library name

Usage

• At the moment you created openvsm library and should place it into MODELS directory of Proteus If you created your model as standalone C library, you don't need to do anything. But if you use Lua for prototyping, the model script should be placed into directory you created previously.
• The name of the script should have the following format: DLL_FILENAME.lua For example, if your dll is 'device.dll', the script should be named 'device.dll.lua'