AC-Sim: AudioCommander's Simulator for MIOS Applications. This has been named after it's creator but hopefully all MIDIBoxers will feel free to contribute to and share their code.

Please see [[mios_c_simulator_-_debugger#Release_and_Developer_Notes]] for version info.\\
If you add something make sure, you note it here, otherwise your submissions might get overwritten!


\\
====== Concept ======

AC-Sim allows you to compile your MIDIBox Application as a command-line application on your Mac or PC (should also run fine with Linux).
Input such as knobs, sliders, buttons (ie AIN and DIN) and MIDI Input can be simulated by entering commands, and the output of the LCD and MIDI Out will be displayed in the console. Please refer to the section "Usage (Manual)" to see what inputs are currently accepted and how to use it.

But you'll discover the real strength of the simulator once you are going to use the graphical debugging interface of your IDE -> you can inspect all the variables and their contents! 

It reduced my number of application uploads dramatically and to be able to use a graphical debugger to watch some variables is quite helpful... Look at that (Pic shows Xcode's GDB-Debugger window):

{{http://www.zeichensprecher.de/bilder/sonst/foren/Xcode_debug.jpg}}

Isn't that nice?


\\

====== Overview ======
The Simulator currently consists of these files:

^ Source								^ Contents							^ Notes										^
| **ACSim_console** (Console based input, main runloop)						| 									| Adaption required!						|
| [[acsim_console_h|ACSim_console.h]]	| Hardware related defines			| Change #defines to reflect your settings	|
| [[acsim_console_c|ACSim_console.c]]	| Main runloop						| Add additional c. source-files here 		|
| **ACSim_mios** (MIOS Emulation)						| 									| //No changes required//					|
| [[acsim_mios_h|ACSim_mios.h]]			| pic18f452.h typedefs and global vars | //No changes required//				|
| [[acsim_mios_c|ACSim_mios.c]]			| MIOS functions for simulation		| //No changes required//					|
| **ACSim_tools**	(Tools & Helpers)					| 									| //No changes required//					|
| [[acsim_toolbox_h|ACSim_toolbox.h]]	| Hexview config | //No changes required//			|
| [[acsim_toolbox_c|ACSim_toolbox.c]]	| Helpers like random generators and hex-view     | //No changes required//			|
| [[acmididefines|ACMidiDefines.h]]  | Midi Defintion listing  | //No changes required//  |

You can download the files in a {{acsim.zip|.zip file here}}. If you make any updates, please send them to sstryd_one and he will update the zip for you.


<box 75% left bluelight|SCM Code News>I created a SCM page for ACSim, but as the current SCM-implementation of Xcode is quite lousy, I will wait for the Leopard version to complete this step. That means the next update 0.0.8 will follow in the near future and will contain some major changes. I am happy for anyone joining the dev team! 
http://code.google.com/p/acsim/ 
//audiocommander 2007/10/26 09:39//
</box>

----
\\

To implement the ACSim files into your applicaton, you just have to follow the [[mios_c_simulator_-_debugger#setup_guide|setup guide]] to:

  * Modify **main.c** and **main.h**
  * Adapt your settings (#defines, #includes) in **ACSim_console.h** as required for your debugging purposes.
  * If you have multiple sources, also #include your .c-sources in **ACSim_console.c**

  * Configure your IDE: 
    * Set up a new target (command-line application)
    * Add //ACSim_console.c//, //ACSim_mios.c// and //ACSim_toolbox.c// to the new target, but don't add any other .c-file!
  * Build and run

\\
When running/debugging, Main() calls: 
  * MIOS_Init()
  * MIOS_LCD_Init()
  * MIOS_Tick() is polled each runloop()
  * MIOS_Timer() is polled each runloop() when a timer has been set

For detailed step-by-step instructions see //Setup Guide// below!



\\

====== Usage (Manual) ======

These input commands are currently available:
    *(**q**)quit
    *(**SPACE**)OK
    *(**r** )andom
    *(**++**) (**-**)
    *(**e**)ncoder(**++**)/(**- - -**)
    *(**a**)(//pin,value//)
    *(**b**)yte(//system realtime number//)
    *(**j**)umper(//pin//)
    *(**p**)rogramChange(//PRG,{store}//)
    *(**m**)idiMessage(//byte0,byte1,byte2//)
    *(**n**)oteOn(//channel,value,velocity//)

\\
**Examples:**
  * Type "q" to exit the runloop
  * Type "a2, 560" to call AIN_NotifyChange(pin 2, value 560)
  * Type "r" to call AIN_NotifyChange(pin random, value random)
  * Type "d4,1" to simulate a button-press on pin 4 (note that 1 means ON in contrast to MIOS_DIN_PinGet(pin) which returns 0 if the circuit is closed!) -> calls DIN_NotifyChange(pin, ON/OFF), where 1 (ON) submits a 0 (0V, closed button) and a 0 (OFF) submits a 1 (5V, open button)
  * Type "j10" to simulate a button press on pin RC5 of J10 -> sets PORTXbits.Rxx to 1 and shortly after back to 0
  * Type the Space-Key to simulate the BUTTON_OK has been pressed -> calls DIN_NotifyChange(OK, 0)
  * Type "+" to increment the Encoder by 1; enter "- - -" (no spaces) to decrement by 3 -> calls ENC_NotifyChange(1, in/decrement)
  * Type "e2+++" to increment Encoder 2 three turns -> calls ENC_NotifyChange(enc, in/decrement)
  * Type "m176,20,100" to send a Midi Controller Change #20 on CH1 (176) with a value of 100 -> calls MPROC_NotifyReceivedEvent
  * Type "m192,10" to send a Program Change request for PRG 10 -> calls MPROC_NotifyReceivedEvent(..)
  * Type "b248" to send a single System Realtime byte (248 is MIDI_CLOCK)


\\





====== Setup Guide ======

If you haven't setup your IDE, please follow these links for your system first:

[[how_to_use_xcode2_as_ide_on_a_mac|Setup Guide for XCode on Mac]]\\
[[windows_toolchain_codeblocks|Extend your toolchain with Code::Blocks and GDB]] (Don't forget [[windows_toolchain_core|Part 1]][[windows_toolchain_asm_acsim| & 2]]!)\\

[[application_development|General Development Info]]


\\
\\
Then proceed by configuring your main.c, and .h files:

== main.c ==

Minor modifications are required to your MIOS Application's main.c file.

  * You need to edit some lines at the top of your main.c - this is to avoid including headers for the PIC/MIOS Core module, when compiling a console app for debugging. Because of the #ifndef statement this does not change your syx-project code, so your app will compile as normal for the PIC!

Before:
<code c>
#include "cmios.h"
#include "pic18f452.h"
</code>

After:
<code c>
#ifndef _DEBUG_C
	#include "cmios.h"
	#include "pic18f452.h"
#endif
</code>

== main.h ==

  * you need to add some lines at the bottom of your main.h, or, if you don't have one, main.c - this is because debug_mios.c calls "DISPLAY_Init()" as MIOS would. Because of the #ifdef statement this does not change your syx-project code!

<code c>
#ifdef _DEBUG_C
  // export functions that are called from within debug_mios.c 
  // (e.g. to trigger DISPLAY_Init after sending...)
  extern void DISPLAY_Init(void);
#endif
</code>

\\


\\
== ACSim_console.h ==

  * Choose your OS by enusering that only one of these lines is remarked (the one you DON'T want!)
    * //#define _DEBUG_OS_WIN
    * //#define _DEBUG_OS_MAC
    
  * Select the LCD-Size
  * Set the number of AIN-Lines
  * Set the number of ENCoders
  * If needed set DIN-Buttons like "OK"
  

\\
== ACSim_console.c ==

If you have more than just main.c, you have to add the source to these .c files (c only, no headers, else you will get a bunch of compile errors. See the comments in the ACSim_console.c file for details.


\\
== ACSim_mios & ACSim_Toolbox incl. ACMidiDefines ==

These files don't need to be changed, just add them to your project.


Done!
:)


\\

====== Release & Developer Notes ======
This entry is still in work. It is very incomplete! Especially beginners should be aware of that it's not yet easy to use. This code is mainly intended to simulate and debug new applications. However, if you know C just a bit, you are welcome to try it!


Everyone is welcome to add lines and code! Change anything! Don't be afraid; I don't see this as _my_ work, I hope the code gets completed piece by piece until we finally have a nice simulator/debugging environment built by the mb-community!  // audiocommander //

\\
Update 0.0.4: now works on MS Windows with GCC (and probably other compilers too) // stryd_one //

Update 0.0.5: splitted code to seperate wiki-documents, code cleanup, cleaned namespaces, added MIOS_ICC and MIOS_HLP functions // audiocommander //

Update 0.0.5-r1: Splitted ACSim_toolbox into header and source // audiocommander //

Update 0.0.5-r2: 2007 January 17 improved MIOS_IIC for SpeakJet debugging // audiocommander //

Update 0.0.6: 2007 January 21 added MIDI-Merger, INTCONbits (MIDI-Clock support) // audiocommander //

Update 0.0.7: 2007 January 26 added MIDI-Debug Messages, improved Timer() calls, added Tick() calls // audiocommander //

\\
\\
**Notes to developers**

Some MIOS_function parameters have slightly been changed due to compile errors.
If you have questions or would like to try it, you can ask in the forum! I'll give my best to help you using ACSim. It's a bit troublesome in the first three hours, but once you got it, it really helps developing MIOS-apps dramatically!!!

**Please** FIXME
  * Lots of hardcoded return values (eg. MIOS_ENC_SpeedGet)
  * Bankstick could be written to and read from a file
  * Many functions are not yet fully implemented. If you add something valueable, please update the Wiki-Sources too or PM me and I'll put it in for you!