Documentation

This page is designed to get you up and running with the eDMX.Net library. Once you have read this document, you should be able to send and receive eDMX with ease.

Working with the libraries.

The library has been developed to be modular. If you only require ArtNet for example, you can ignore the other protocols all together. There are common functions for interacting with the libraries so it should be trivial for you to implement any new protocols added.

All the output engines require a library named Liteshared. This is part of a library I have been developing for another project which I have striped down and built for the eDMX library. It simply contains a Dmx-in object as well as an enum for supported DMX transmission types. It must be included in your projects in order to the engines to run. Without it you will not be able to build from the source.

I have developed the framework around the notion that each library is a transport vehicle for data. Each vehicle has an engine which has functions which you might expect. These functions include Start & Pause as well as being able to check that status of the engine. I may also add the ability to set the speed of the engine at a later date if requested.

Starting the Engines

In order to start using the libraries, the Engines much first be created. Below is an example of how to create an ArtNet engine and send some data.

C#

static void Main(string[] args)
       {
           //Should start sending lots of ArtPoll packets.
           ArtNet.Engine ArtEngine = new ArtNet.Engine("Example Name", "");
           ArtEngine.Start();

           byte[] DMXData = new byte[512];

           DMXData[0] = 127;
           DMXData[1] = 255;
           DMXData[510] = 127;
           DMXData[511] = 255;

          ArtEngine.SendDMX(64, DMXData, DMXData.Length);           
       }

VB.Net

Private Shared Sub Main(args As String())
	'Should start sending lots of ArtPoll packets. 
	Dim ArtEngine As New ArtNet.Engine("Example Name", "")
	ArtEngine.Start()

	Dim DMXData As Byte() = New Byte(511) {}

	DMXData(0) = 127
	DMXData(1) = 255
	DMXData(510) = 127
	DMXData(511) = 255

	ArtEngine.SendDMX(64, DMXData, DMXData.Length)

End Sub

Important notes on starting an engine.

Its important to know that when creating an engine, you can pass 2 optional string variables. These allow to you to set the name and broadcast address for the protocol engine you are creating. If you leave these blank, these have a default setting which will be used.

ArtNet Defaults:

Name: LiteCore

Broadcast Address: 255.255.255.255

Last edited Jan 3, 2012 at 12:03 PM by MichaelJames, version 26

Comments

zktech Jan 14, 2014 at 11:33 AM 
What are the dependencies for the mobile versions of the project to load?