DMXPLUS.DLL - Digimedia MLS
Contents
1. f dmxchan2 As Long ByRef dmxsbrv As Long ByRef dmxsize As Long ByRef dmxstatus As ByRef dmxstart As ByRef dmxchan As Long ByRef revsiz As Long ByRef mast As Long ByRef ByRef dmxpatch As ByRef dmxstatus As ByRef ByRef dmxstart As Declare Sub DMXINIT Lib dmxplus dll ByRef lpt As Long ByRef dmxmast As Long Declare Sub DMXSENSE Lib dmxplus dll ByRef lpt As Long Long ByRef dmxtype As Long Declare Sub DMXRELAX Lib dmxplus dll ByRef lpt As Long Declare Sub DMXSTANDARD ad mxplus dll ByRef lpt As Long Declare Sub DMXDRIVE Lib dmxplus dll ByRef lpt As Long Long ByRef dmxstatus As Long Declare Sub DMXSEND Lib dmxplus dll ByRef lpt As Long Declare Sub DMXREV Lib dmxplus dll ByRef lpt As Long ByRef revbuf As Long Declare Sub DMXPTCSND Lib dmxplus dll ByRef lpt As Long ByRef dmxchan As Long ByRef dmxchanl As Long ByRe dmxchan3 As Long ByRef dmxchan4 As Long ByRef dmxgr As Long Long ByRef dmxpatchlev As Long ByRef dmxcurva As Long Declare Sub DMXIDENT Lib dmxplus dll ByRef lpt As Long Long ByRef dmxhard As Long ByRef dmxrv As Long serialno As Long Declare Sub DMXCAPTURE Lib dmxplus dll ByRef lpt As Long Long ByRef dmxpkt As Long ByRef dmxchan As Long Declare Sub LIBVER Lib dmxplus dll ByRef version As Long DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 25 of 262. printf yn Drive command error status x Mn dmxstatus else printf nDrive command successful set default array values for i20 i lt dmxsize i dmxchan i 0 setup channel at zero dmxchanl i 0 setup chaserl at zero dmxchan2 i 0 setup chaser2 at zero dmxchan3 i 0 setup chaser3 at zero dmxchan4 i 0 setup chaser4 at zero dmxpatch i i li default patch 1 1 77 dmxpatchlev i 100 default patchlevel full dmxcurve i 0 default curve lineart master for i 0 i lt dmxsizetl i dmxgr i 0 setup groups at zero set set DMX channel values in dmxchan buffer master and individual circuit patch curve and level ct ct DMXPTCSND amp mast amp dmxchan 0 amp dmxchanl 0 amp dmxchan2 0 amp dmxchan3 0 amp dmxchan4 0 amp dmxgr 0 amp dmxpatch 0 amp dmxpatchlev 0 amp dmxcurve 0 patch send DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 18 of 26 3 2 Master Slave program A simple application that switches between Master and Slave modes is reported in the following Note that different than with DMXPlus hardware the DMXAdp low cost compact interface allows dynamic automatic switch between master and slave mode only with the Intelligent Cable option In fact to avoid conflicts when
3. DMXDRIVE amp lpt amp dmxstart amp dmxstatus enable DMX line driver if dmxstatus 0 printf An Drive command error status bx Mn dmxstatus set DMX channel values in dmxchan buffer DMXSEND amp lpt amp dmxchan 0 send channels values to DMX line back to DMXCAPTURE loop at any time to return to Slave Mode DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 19 of 26 APPENDIX A Using DMXPLUS DLL in different languages A 1 Delphi uses Messages SysUtils Classes Controls Dialogs StdCtrls Buttons ExtCtrls procedure EstablishDMXLink procedure INITDMX procedure SendDMX implementation uses Unitl var DMXSIZE DMXMST DMXSTART DMXTYPE DMXHARD DMXREV DMXSUBREV SERIALNO PChar PTENABLED array 0 2 of Boolean LPT DMXCHAN DMXSTATUS array 0 2 of PChar procedure DMXINIT lpt dmxsize dmxmst PChar stdcall external dmxplus dll E procedure DMXDRIVE lpt dmxstart dmxstatus PChar stdcall external dmxplus dll procedure DMXSENSE lpt dmxstatus dmxtype PChar stdcall external dmxplus dll procedure DMXSEND lpt dmxchan PChar stdcall external dmxplus dll procedure DMXIDENT lpt dmxstatus dmxhard dmxrev dmxsubrev serialno PChar stdcall external dmxplus dll procedure Esta
4. Nok ck ck ck ck Ck Ck Ck Ck Ck CK C CC Ck Ck A E A M Kk ko ko A kx M PROGRAM in form or module code XN NK KKKKKKKKKKKKKKKKKKKKKKKKKKKKK NKKKKKKKKKKKKKKK variables setup NKKKKKKKKKKKKKKK dmxsize 512 dmxmst 1 dmxstart 0 dmxstatus 0 dmxhard dmxrv dmxsbrv dmxsize 512 dmxpkt 0 dmxtype 0 revsiz mast 10 version 0 serialno 0 I o I NOkCKCk Ck Kk ck KC KK KK KK MK KK KK Kk kk Mk DMX Interface initialization Nok ck ck ck kk Ck Ck CK CK C CC Ck S A A A x x MAX default LPT assignment init lpt amp H378 initialize DMX interface Call DMXINIT lpt dmxsize dmxmst NK KKKKKKKKKKKKKKKKKKKKKKKKKKKKK KKK KK KK simple DMX send all channels to zero NKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK KK KKK case Standard DMX timings default Issue Drive command to enable DMX output Call DMXDRIVE lpt dmxstart dmxstatus Debug Print status Str dmxstatus case Relaxed DMX timings alternative Call DMXRELAX lpt Issue Drive command to enable DMX output Call DMXDRIVE lpt dmxstart dmxstatus Debug Print status Str dmxstatus setup channels For J 1 To dmxsize dmxchan J 0 Next J send DMX channels values to DMX Call DMXSEND lpt dmxchan 1 DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 26 of 26 NKKKKKKKKKKKKKKKKKK simple DMX receive NKKKKKKKKKKKKKKKKKK setup array to pre
5. DLL function definitions Following the Win32 definition DMXPLUS DLL uses the stdcall calling convention for all parameters The list of functions supported by DMXPLUS DLL is reported in the following table DMXSEND Ipt dmxchan DMXPTCSND Ipt mast dmxchan dmxchan1 dmxchan2 dmxchan3 dmxchan4 dmxgr dmxpatch dmxpatchlev dmxcurve DMXIDENT Ipt dmxstatus dmxhard dmxrev dmxsubrev serialno DMXREV Ipt revsiz revbuf LIBVER version In the following each function is defined in detail As seen all DLL functions that involve operation of the DMX line are Ipt parametric i e they accept the Ipt port address as an input parameter This allows simple support of up to three DMX interfaces on the three architected and supported LPT ports base address 0x278 0x378 Ox3BC DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 4 of 26 2 1 DMXINIT The DMXINIT function is called once at program initialization in order to setup the DLL variables associated with the specified Ipt interface The Ipt parameter specifies the lpt port of the DMX interface The dmxsize parameter is used to setup the size of the buffer used by the DLL to handle DMX channel values and is normally set at 512 for all selected Ipt ports The dmxmst parameter is used to setup the driving state master vs slave of the DMX interface Master mode is selected with dmxmst 1 and Slave Mode with dmxmst 0 Setting dmxmst 1 Master Mode specifies an internal
6. DMXPLUS DLL Win32 DLL for Digimedia DMX 512 interface products OEM User s Manual Ver 1 1 1998 Digimedia Multimedia Lighting Solutions All rights reserved DMXPLUS DLL OEM User s Manual V1 1 ODigimedia MLS 1997 1998 Page 2 of 26 TABLE OF CONTENTS 1 INTRODUCTION 2 2 1 2 2 2 3 2 4 2 5 2 6 2 7 2 8 2 9 DLL FUNCTION DEFINITIONS MXINIT MXDRIVE MXSTANDARD D D DMXRELAX D DMXSENSE D MXCAPTURE DMXSEND DMXPTCSND DMXIDENT 2 10 DMXREV 2 11 LIBVER 3 3 1 3 2 Master only program with identification and patch send 3 2 APPENDIX A USING DMXPLUS DLL IN DIFFERENT LANGUAGES USING DMXPLUS DLL FUNCTIONS Simple Master only program Master Slave program A 1 Delphi A 2 Visual C A 3 Visual Basic 10 11 13 14 15 16 16 17 18 19 19 23 24 DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 3 of 26 1 Introduction DMXPLUS DLL is a Win32 compatible Dynamic Link Library DLL that supports the operation of DMX interfaces offered by Digimedia namely DMXPlus and DMXAdp As with any Win32 DLL the library may be used by all high level language environment including the modern RAD environments operating under Windows95 Use of DMXPLUS DLL for use out of Digimedia proprietary lighting control software is subject to an OEM agreement between Digimedia and the OEM customer 2
7. ParDmx interface after issuing a reverse line command Captures all DMX 512 startcodes and return startcode Packet size is adaptive and returned to calling program Checks handshake timeouts and returns DMXPkt 0 on any error If a hardware command handshake error is detected error is logged in DmxErr and will be reported as fatal by the next DMXSense call C prototype extern stdcall DMXCAPTURE int int int int VB4 prototype Declare Sub DMXCAPTURE Ipt dmxstart dmxpkt dmxchan input parameters Ipt 32 bit pointer to Lpt base address dmxchan 32 bit pointer to DMX channels array max 512 words output parameters dmxstart 32 bit pointer to startcode of received DMX packet dmxpkt 32 bit pointer to received DMX packet lenght ek KKK KKK kk ke ehe hehe ke kk ehe hehe kk ehe KKK KK ehe KKK KKK RRR KKK ke ee kk ke eek DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 10 of 26 2 7 DMXSEND The DMXSEND function is simply user to update the channel values to be transmitted on the DMX line All DMX interfaces designed by Digimedia are intelligent and perform automatic refresh of the DMX line with the last transferred values All crossfades are computed by the PC CPU and transferred to the interface with the DMXSEND function The Ipt parameter specifies the parallel port The dmxchan parameter is a pointer to the channel buffer that must be an array of 32 bit words a
8. chr Unitl Setup Dmx DmxTmp Preheat If Unitl Setup DMX DmxTmp Ch div 512 2 then DMXCHAN 2 4 Unitl Setup DMX DmxTmp Ch chr Unitl Setup Dmx DmxTmp Preheat end If LPTENABLED 0 then DMXSEND LPT 0 DMXCHAN 0 If LPTENABLED 1 then DMXSEND LPT 1 DMXCHAN 1 If LPTENABLED 2 then DMXSEND LPT 2 DMXCHAN 2 end DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 22 of 26 procedure SendDMX Word var Dmxtmp begin For DmxTmp begin Unit1 P 512 Pointer4 If Unitl Setup DMXCHAN 1 4 Unit1 Unit1 P 512 Pointer DmxTmp If Unitl Setup DMXCHAN 2 4 Unit1 P 512 Pointer end If Unitl begin end If If Unitl Setup DMX Dmx DMXCHAN 0 4 Unit1 rFDmxTmp I i I f f U DMXCHAN 0 4 f Unitl Setup DMXCHAN 1 4 Unitl Setup DMXCHAN 2 4 ENAB If ED 0 ENAB ED 1 If ENAB ED 2 end end 0O to 511 do DMX Dmx Setup DMX Dmx Setup DMX Dmx DMX Dmx ax gt 0 then DMX t4 Unitl rFDmxTmp rmp Ch div 512 rmp Ch div 512 rmp Ch div 512 O0 then mp Ch 1 then mp Ch 2 then nitl Setup DMX Unitl Max 1 Ch div 512 nitl Setup DMX Unitl Max nitl Setup DMX Unitl Max Unitl Max 1 Ch div 512 DMX Unitl Max 1 Ch div 5
9. dmxchan i int bloc il int 0 lpFonction GetProcAddress hLibrary DMXSEND lpFonction amp lpt amp dmxchan 0 setup DLL variables DMXSEND amp lpt amp dmxchan 0 send new channels on DMX line last packet sent is automatically refreshed on DMX line by DMXADP hardware DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 24 of 26 A 3 Visual Basic NK KKKKKKKKKKKKKKKKKKKKKKKKKKKKK Definitions in main BAS module NOkCkCk ck kk ck kk Ck Ck Kk KC KK Kk Kk Kk kk kk ko kk NCkCkCk ck kk k ck ck k kk k k k kk kk variables declaration No ok ck ck ck ck ockckockockockckckckckck kck kk blic blic blic blic blic blic blic blic blic blic blic blic blic blic Pu Pu Pu Pu Pu Pu Pu Pu Pu Pu Pu Pu Pu Pu lpt As Long dmxsize As Long dmxmst As Long dmxstatus As Long dmxhard As Long dmxrv As Long dmxsbrv As Long dmxstart As Long dmxpkt As Long dmxtype As Long revsiz As Long mast As Long version As Long serialno As Long NKKKKKKKKKKKKKKKKKK arrays declaration NKKKKKKKKKKKKKKKKKK revbuf 32 As Long dmxchan 512 As Long revstr 32 As String verstr 4 As String Public Public Public Public NK KKKKKKKKKKKKKKKKKKKKKKKKKK DLL subroutines declaration NK KKK ck ck Ck ck KKK KK KK kk Sk kk S Kk ok kx kx X
10. high level program with no DMX interface connected e g for off line show preparation the DLL enters an automatic demo mode when the first DMXSENSE call executed after DMXINIT returns command timeout In this case all the following function calls are skipped to let the program run unchanged with no hardware connected and no timeout overhead The type of interface connected including the no hardware demo case is reported in detail by the DMXIDENT function skkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk DMXSENSE Ipt dmxstatus dmxtype function Issues Sense command to ParDmx to test if it is present and what type of hardware is present and resets DmxPres flag only when called first time checked via FirstSns flag if hardware not sensed Function skipped with ok return code if DmxPres flag inactive to allow automatic demo mode of periodic Sense call Reports cumulative status information about previous silent errors on DMXSend or DMXPtcSnd to support periodic off line error test First DMXSense call to be done after DMXInit before any other function call C prototype extern stdcall DMXSENSE int int int VB4 prototype Declare Sub DMXSENSE Ipt dmxstatus dmxtype input parameters lpt 32 bit pointer to Lpt address output parameters dmxstatus 32 bit pointer to DMXStatus DMXStatus 0000h ParDmx present no errors logged xxyy errors where xx lt gt 0 Sen
11. receive data to check update from DMX channels from StartCode For J 1 To dmxsize dmxchan J amp H55 Next J Call DMXCAPTURE lpt dmxstart dmxpkt dmxchan 1 Debug Print Received Str dmxpkt Str dmxstart Debug Print Capture Complete captured channels are in dmxchan i array NK KKKKKKKKKKKKKKKKKKKKKKKKK Get DMX interface revision NK KKK KK KK KKK KEK KKK ko Kk Sk kx Sk Kk Mk ko ko Call DMXREV lpt revsiz revbuf 1 For i 1 To 32 revstr i Next i For i 1 To revsiz revstr i Chr revbuf i Mod 256 Next i NKKKKKKKKKKKKKKKKKKKKK Identify DMX Inteface NKKKKKKKKKKKKKKKKKKKKK Call DMXIDENT lpt dmxstatus dmxhard dmxrv dmxsbrv serialno If dmxrv 0 And dmxsbrv 0 Then Debug Print HW 0 none 1 DMXPlus Base 2 DMXPlus Pro 3 DMXADP RV Chr dmxrv Chr dmxsbrv 256 sn Hex serialno End If NKKKKKKKKKKKKKKK get DLL Version NK KKKKKKKKKKKKKK Call LIBVER version extract version string from zy x byte string For i 1 To 4 verstr i Chr version Mod 256 version version 256 Next i Debug Print Library Version verstr 1 verstr 2 verstr 3 Str dmxhard Chr dmxsbrv Mod 256 W verstr 4
12. specified STDCALL calling convention all parameters are far e g 32 bit pointers The first information to determine is the base address of the LPT port used for the DMX interface A set of different techniques may be used from user option box to automatic identification The simplest one is a static LPT port setup that may be modified with a configuration menu As a reminder note that the LPT1 LPT2 LPT3 port identifier used by Microsoft are not in direct relationship with the base address The three architected base adresses for the IBM compatible PCs are 0x278 0x378 most likely the default for single port PCs and Ox3BC Most BIOS setup procedures include LPT base address and display the base address when booting the machine Under Win95 the base address may be obtained using the Configuration Panel System Port Properties menu Note that DMXPLUS DLL uses the simplest mode of the LPT port also called SPP for Standard Parallel Port and it does not use the PS 2 bidirectional or the EPP enhanced mode Therefore any LPT port may be used for current Digimedia products guaranteeing total compatibility with any parallel port interface Here is the simplest sequence for a DMX send application in pseudo C format lpt 0x378 set depending on selected LPT port dmxsize 512 dmxmst 1 set internal driving active mode dmxstart 0 startcode for DMX 512 1990 dimmers DMXINIT amp lpt amp dmxsize a
13. using the standard cable with DMXAdp the DMX IN signal should be disconnected and a termination inserted when switching from Slave to Master Mode Using the values returned by DMXSENSE and DMXIDENT the program may detect the configuration DMXAdp and standard cable and warn the user to cable the line accordingly While this is suitable for unfrequent Master Mode use by mostly Slave applications e g a DMX monitor all applications requiring hot key on the fly switch between Mater and Slave will practically require the intelligent cable option of the most powerful DMXPlus hardware This case is reported in the following example lpt 0x378 set depending on selected LPT port dmxsize 512 dmxmst 0 clear internal driving active mode dmxstart 0 startcode for DMX 512 1990 dimmers DMXINIT amp lpt amp dmxsize amp dmxmst setup DLL variables DMXSENSE amp lpt amp dmxstatus amp dmxtype first sense DMXIDENT amp lpt amp dmxstatus amp dmxhard amp dmxrev amp dmxsubrev amp serialno report dmxhard dmxrev dmxsubrev serialno to user perform the following capture in loop as required DMXCAPTURE amp lpt amp dmxstart amp dmxpkt amp dmxchan 0 if dmxpkt 0 handle captured channel values else handle timeout no DMX signal case when desired switch to Master Mode as follows
14. 0 to 2047 do begin DMXCHAN 0 Dmxtmp DMXCHAN 1 Dmxtmp DMXCHAN 2 Dmxtmp 0 Ce RN Ce RN end For Dmxtmp 0 to 511 do begin If Unitl Setup Dmx Dmxtmp Ch div 512 begin 0 then LPTENABLED 0 true end If Unitl Setup Dmx Dmxtmp Ch div 512 1 then begin LPTENABLED 1 true end If Unitl Setup Dmx Dmxtmp Ch div 512 2 then begin LPTENABLED 2 true end end If LPTENABLED 0 then DMXINIT LPT 0 DMXSIZE DMXMST If LPTENABLED 1 then DMXINIT LPT 1 DMXSIZE DMXMST If LPTENABLED 2 then DMXINIT LPT 2 DMXSIZE DMXMST If LPTENABLED 0 then begin DMXSENSE LPT 0 DMXStatus 0 DMXType If DMXStatus 0 0 and DMXStatus 0 41 0 and DMXStatus 0 42 0 and DMXStatus 0 43 0 DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 21 of 26 then LPTENABL else LPTENABL If LPTENABLED DMXSUBREV SERIALNO end If LPTI begin D 0 true D 0 false 0 then DMXIDENT LPT 0 DMXSTATUS 0 DMXHARD DMXREV Lr NABLED 1 then DMXSENSE LPT 1 DMXStatus 1 DMXType If DMXStatus 1 0 and DMXStatus 1 1 0 and DMXStatus 1 2 0 and DMXStatus 1 4
15. 12 Unitl Setup DMX Unitl Max 1 Setup DMX DmxTmp Ch 0 1 1 1 2 then DMXSEND LPT 0 DMXCHAN 0 then DMXSEND LPT 1 DMXCHAN 1 then DMXSEND LPT 2 DMXCHAN 2 then Ch then Ch then Ch 3 Chr 255 Chr 255 Chr 255 DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 23 of 26 A 2 Visual C Gl BOOL dmxeasy_ok FALSI HINSTANCE hLibrary FARPROC lpFonction int lpt dmxsize dmxmst dmxstart dmxstatus BOOL Init dmxeasy lpt 0x378 set depending on selected LPT port dmxsize 512 dmxmst 1 1 SEND O CAPTURE set internal driving active mode dmxstart 0 startcode for DMX 512 1990 dimmers hLibrary LoadLibrary dmxplus if hLibrary NULL return FALSE lpFonction GetProcAddress hLibrary DMXINIT lpFonction amp lpt amp dmxsize amp dmxmst setup DLL variables DMXINIT amp lpt amp dmxsize amp dmxmst setup DLL variables lpFonction GetProcAddress hLibrary DMXDRIVE lpFonction amp lpt amp dmxstart amp dmxstatus setup DLL variables DMXDRIVE amp lpt amp dmxstart amp dmxstatus enable DMX line driver if dmxstatus 0 return FALSE return TRUE void dmxeasy unsigned char bloc int canaux int dmxchan 512 i for is0 i 512 i if i canaux dmxchan i else
16. 3 0 then LPTENABLED 1 true else LPTENABLED 1 false If LPTENABLED 1 then DMXIDENT LPT 1 DMXSTATUS 1 DMXHARD DMXREV DMXSUBREV SERIALNO end If LPTENABLED 2 then begin DMXSENSE LPT 2 DMXStatus 2 DMXType If DMXStatus 2 0 and DMXStatus 2 1 0 and DMXStatus 2 2 0 and DMXStatus 2 73 0 then LPTENABLED 2 true else LPTENABLED 2 false If LPTENABLED 2 then DMXIDENT LPT 2 DMXSTATUS 2 DMXHARD DMXREV DMXSUBREV SERIALNO end If LPTENABLED 0 then DMXDRIVE LPT 0 DMXSTART DMXSTATUS 0 If DMXSTATUS 0 lt gt 0 then begin LPTENABLED 0 false end If LPTENABLED 1 then DMXDRIVE LPT 1 DMXSTART DMXSTATUS 1 If DMXSTATUS 1 40 then begin LPTENABLED 1 false end If LPTENABLED 2 then DMXDRIVE LPT 2 DMXSTART DMXSTATUS 2 If DMXSTATUS 2 lt gt 0 then begin LPTENABLED 2 false end For DmxTmp 0 to 511 do begin If Unitl Setup DMX DmxTmp Ch div 512 0 then DMXCHAN 0 4 Unitl Setup DMX DmxTmp Ch chr Unitl Setup Dmx DmxTmp Preheat If Unitl Setup DMX DmxTmp Ch div 512 1 then DMXCHAN 1 4 Unitl Setup DMX DmxTmp Ch
17. EV from Master mode clears the active driving state and require a DMXDRIVE command to be re issued before making DMXSEND or DMXPTCSND calls The Ipt parameter specifies the parallel port The revsiz return parameter specifies the number of revision bytes returned by the interface equal to 30 for all present Digimedia hardware The revbuf parameter is a pointer to a revision buffer that must be at least 32 words long The typical returned revision strings are in the following format DMXPlus 1996 no revision string 1997 C DMXEASY 97 PLUS sssss Vr rr DMXAdp 1996 C DMXEASY 1996 DMXADP Vr rr 1997 C DMXEASY 97 ADP sssss Vr rr 1998 GDIGIMEDIA 98 ADP sssss Vr rr Where r rr is a revision subrevision field e g 1 71 or 3 10 and sssss is a 5 digit serial number e g 00102 This is the function prototype akk KKK e k kk k k k k k kk kk k k k kkk k ehe hehe ke ke kk kkk kk kk kkk kk ehe ke heck ee kk ke eek ke ke eee ke DMXREV Ipt revsiz revbuf function Captures a revision level packet from DMXADP Checks handshake timeouts and returns DMXPkt 0 on any error C prototype extern __stdcall DMXREV int int input parameters none Ipt 32 bit pointer to Lpt base address output parameters revsiz 32 bit pointer to size of received rev packet revbuf 32 bit pointer to received rev packet size lt 16bytes KKK KK KKK ke ke kk ehe hehe KK KKK KKK
18. K k k KK KKK k k k k k k k k k KK k k k k k k k k k k k k k k k k k kk k k k k kk kkk k kkk kkk kk kkk kkk kkk eek kk kkk DMXSEND Ipt dmxchan function send DMX channel values for pre configured size onto ParDmx interface in case of handshake timeout the function is skipped and an error is logged on DmxErr variable C prototype extern stdcall DMXSEND int VB4 prototype Declare Sub DMXSEND Ipt dmxchan input parameters lpt 32 bit pointer to Lpt base address dmxchan 32 bit pointer to DMX channels array max 512 dwords output parameters none ARK KKK KK ke hehe kk ke hehehe ke ke ke ehe hehe kk ehe he heck ehe hehe kk ehe ke kk ke ke heck eek eek ke eee DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 11 of 26 2 8 DMXPTCSND The DMXPTCSND Patch Send is a structured version of the DMXSEND designed to offload the high level program from some channel management tasks that are typical of lighting consoles Being entirely written in machine language the DLL is much faster at perfroming these functions than the high level calling program The Ipt and dmxchan parameters have the same meaning of the DMXSEND function The dmxchan1 dmxchan2 dmxchan3 dmxchand are pointers to four additional channel buffers that operates in the HTP Highest Takes Priority fashion to implement high level functions like chasers The dmxgr is a pointer to a Group buffer that is used to impleme
19. KKK ke he heck ehe ke heck eee ke ke kc eek ke eek ke eek DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 15 of 26 2 11 LIBVER The LIBVER function is simply used to report the revision level of the DMXPLUS DLL library to the high level calling program This is used to report a global configuration to the user and simplify field maintenance The only returned parameter is version that is a ASCII packed word in the x yz format e g 6 50 skkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk LIBVER version function return DMX library version C prototype extern stdcall LIBVER int VB4 prototype Declare Sub LIBVER version input parameters none output parameters none version 32 bit pointer to version structure x yz ASCII kk kk ek ee ce ck ck ck ek e ke ee e e kk ck ck heck ec ke ce ce ck ke ke kk ec ke ee ke e ke e ke e e e e e e 5 DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 16 of 26 3 Using DMXPLUS DLL functions Three applications of DMXPLUS DLL are described herein Granted OEM users may get additional information on the DLL contacting technical support at Digimedia using the email support digimedia mls com or website http www digimedia mls com entry points 3 1 Simple Master only program The simplest application is a program that only sends DMX to control lighting equipment Following Win32
20. active driving state that is used by the DLL to modify the execution of some functions and it does not have any effect on the actual driving state of the DMX line that is instead controlled by DMXDRIVE For example when not in active driving state i e when in Slave Mode the DLL fakes i e no op DMXSEND call allowing the high level program to be simpler Here is the function template skkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk DMXINIT Ipt dmxsize dmxmst function Initializes DMXLIB module variables to be issued before f issuing any other DMX command C prototype extern stdcall DMXINIT int int int VB4 prototype Declare Sub DMXINIT Ipt dmxsize dmxmst input parameters Ipt 32 bit pointer to Lpt base address dmxsize 32 bit pointer to DMX string size 1 to 512 channels dmxmst 32 bit pointer to DMX Master Slave mode 1 Master 0 Slave output parameters none skkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk kkk kkk kkk kkk kkk kk kkk DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 5 of 26 2 2 DMXDRIVE The DMXDRIVE function is used to enable the DMX interface to drive the DMX line The Ipt parameter is used to specify the port where the DMX interface is connected The dmxstart parameter is used to set the Startcode Byte as defined by DMX 512 1990 and is normally set at 0 for standard DMX devices like dimmers scroll
21. blishDMXLink var Dmxtmp Word begin PTENABLED O false PTENABLED 1 false PTENABLED 2 false GetMem DMXSIZE 4 GetMem DMXMST 4 GetMem LPT 0 4 GetMem LPT 14 GetMem LPT 2 4 GetMem DMXSTART 4 GetMem DMXSTATUS 0 4 GetMem DMXSTATUS 1 4 GetMem DMXSTATUS 2 4 GetMem DMXTYPE 4 GetMem DMXHARD 4 GetMem DMXREV 4 GetMem DMXSUBREV 4 GetMem SERIALNO 4 GetMem DMXCHAN 0 2048 GetMem DMXCHAN 1 2048 GetMem DMXCHAN 2 2048 DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 20 of 26 For Dmxtmp 0 to 3 do begin DMXSIZE Dmxtmp Q DMXMST tDmxtmp LPT 0 Dmxtmp LPT 1 Dmxtmp LPT 2 Dmxtmp XSTART Dmxtmp 0 XSTATUS 0 Dmxtmp TATUS 1 Dmxtmp XSTATUS 2 Dmxtmp 0 XTYPE Dmxtmp 0 Ce M Ce M OUUUUJg ad o 3 end DMXSIZE T1 25 DMXMST 1 LPT 0 1 120 LPT 3 LPT LPT 3 1 i eee 120 1 5 e 2 13 95 188 LPT LPT DMXSTART gt 0 end procedure InitDMX var Dmxtmp Word begin For Dmxtmp
22. de hehe ke kk ehe hehe ke ke ehe hehe heck eee he heck ke ke hehe ke ehe hehehe ee ke ke kc DMXSTANDARD pt function Set Standard Timings on DMX line Changes are effective on next DMXDRIVE function Cu prototype extern C DMXSTANDARD int VB4 prototype Declare Sub DMXSTANDARD lpt input parameters Ipt 32 bit pointer to LPT port address output parameters none eckeke KKK ee hehe ke ke ke ede hehe ke ke ke ehe hehe ke ke ke ehe hehehe kk ehe hehe heck ehe hehe heck hehehe kk ee ke ke ecce kk ke eek ek eee DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 8 of 26 2 5 DMXSENSE The DMXSENSE function is used to check the presence of the DMX interface and it reports some information on the interface type The Ipt parameter is used to specify the port where the DMX interface is connected The dmxstatus return parameter is used to report cumulative errors and should always be returned at O If different than zero the value should be reported to the user for troubleshooting The dmxtype return parameter is used to repor a two state condition With DMXPlus this is used to report which model is connected the PRO or the BASE model now discontinued by Digimedia With DMXAdp this is used to report which cable is connected regular cable or Intelligent Cable and let the program prompt the user for manual termination handling when the standard cable is used Note that to simplify the use of the
23. ers and scanners The dmxstatus is a return value that is used to verify normal execution of the function When DMXDRIVE execution is successful the return value of dmxstatus must be 0 Any value different than 0 should be flagged to the user indicating problems in the connection of the DMX interface that result in command timeout Prior to DMXDRIVE call the DMXRELAX function may be called to select relaxed DMX timings see next chapters kkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk DMXDRIVE Ipt dmxstart dmxstatus function Issue Drive command to ParDmx to prepare for DMXSend or DMXPtcSnd set DrvAct variable on completion Check for timeout during hardware handshake due to fatal hardware errors of ParDmx interface C prototype extern stdcall DMXDRIVE int int int VB4 prototype Declare Sub DMXDRIVE Ipt dmxstart dmxstatus input parameters lpt 32 bit pointer to Lpt base address dmxstart 32 bit pointer to dmxstart DMX Start Code output parameters dmxstatus 32 bit pointer to dmxstatus dmxstatus lt gt 0000h timeout 0000h2successful eK KKK KK ehe he ek ke eee he ke kk eee he ke kk ehe hehe heck ke ehe hehe heck ke ehe hehehe ee hehehe ke ke ke kk eek ek ek eee DMXPLUS DLL OEM User s Manual V1 1 ODigimedia MLS 1997 1998 Page 6 of 26 2 3 DMXRELAX The DMXRELAX function is used to command the DMX interface to use relaxed timings on the DMX
24. i 255 NEXT i CALL DMXSEND lpt dmxch 1 The algorithm shown allows sophisticated channel control to be automatically performed by the DLL with no burden on the high level program other than the compilation of the channels patch and curve arrays DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 12 of 26 The PTCSND function prototype is reported in the following ek e hehe ke ke ke hehehe kk ke hehehe kk ke hehehe kk ke hehehe kk ke ehe heck ke e ke kk ke ehe ke kk ke ke ke ke eee iDMXPTCSND Ipt mast dmxchan dmxchan1 dmxchan2 dmxchan3 dmxchan4 dmxgr dmxpatch dmxpatchlev dmxcurve function send DMX channel values for pre configured size onto 1 ParDmx interface applying Master Group Patch PatchLevel and Curve parameter in case of hahdshake timeout the function is skipped and an error is logged on DmxErr variable input parameters Ipt 32 bit pointer to LPT port address integer mast 32 bit pointer to master value integer dmxchan 32 bit pointer to DMX channels array 512 dwords i dmxchant1 32 bit pointer to DMX channels array 1 512 dwords dmxchan2 32 bit pointer to DMX channels array 2 512 dwords dmxchan3 32 bit pointer to DMX channels array 3 512 dwords dmxchan4 32 bit pointer to DMX channels array 4 512 dwords dmxgr 32 bit pointer to DMX Group array 512 dwords i dmxpatch 32 bit pointer to DMX Patch array 512 dwords dmxpatchlev 32 bi
25. line The Ipt parameter is used to specify the port where the DMX interface is connected This function is typically useful when working with critical or marginal DMX 512 equipment that cannot tolerate the maximum theoretical speed and may therefore need relaxed timing Here is how typical timings are altered values for Digimedia DMXADP Compact Parallel Port Adapter DMXADP Relaxed Parameter Lr sande SS Sa oe 198 205 Break to Break Updates sec 35 36 DMXRELAX Ipt function Set Relaxed Timings on DMX line Changes are effective on next DMXDRIVE function C prototype extern C DMXRELAX int VB4 prototype Declare Sub DMXRELAX lpt input parameters lpt 32 bit pointer to LPT port address output parameters none kkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 7 of 26 2 4 DMXSTANDARD The DMXSTANDARD function is used to command the DMX interface to use standard timings on the DMX line This function may be used to eliminate the effect of a previously issued DMXRELAX function The Ipt parameter is used to specify the port where the DMX interface is connected Standard DMX timing values are restored on the next call to DMXDRIVE therefore a DMXSTANDARD DMXDRIVE sequence is required to reset a DMXRELAX DMXDRIVE sequence eK KKK KK ehe he ke ke ke e
26. mp dmxmst setup DLL variables DMXDRIVE amp lpt amp dmxstart amp dmxstatus enable DMX line driver if dmxstatus 0 printf n Drive command error status x n dmxstatus else printf nDrive command successful set DMX channel values in dmxchan buffer DMXSEND amp lpt amp dmxchan 0 send new channels on DMX line last packet sent is automatically refreshed on DMX line by DMXADP hardware DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 17 of 26 3 2 Master only program with identification and patch send A more complete Master program that identifies hardware and uses the complete Patch Send functions would use the following flow lpt 0x378 set depending on selected LPT port dmxsize 512 dmxmst 1 set internal driving active mode dmxstart 0 startcode for DMX 512 1990 dimmers mast 100 set Grand Master at full DMXINIT amp lpt amp dmxsize amp dmxmst setup DLL variables DMXSENSE amp lpt amp dmxstatus amp dmxtype first sense DMXIDENT amp lpt amp dmxstatus amp dmxhard amp dmxrev amp dmxsubrev amp serialno report dmxhard dmxrev dmxsubrev serialno to user DMXDRIVE amp lpt amp dmxstart amp dmxstatus enable DMX line driver if dmxstatus 0
27. nt high priority registers The mast parameter is the Grand Master and it allows local master control 0 100926 performed automatically by the DLL This is done on all channels that do not have Mater Inhibit curves as explained in the following The dmxpatch dmxpatchlev are pointers to two arrays that perform the modulated patch function In this way a channel may be attributed to a dimmer with a specific level 0 200 that allows adjusting dimmer levels to lamp chracteristics maintaining the show unchanged Finally the dmxcurve specifies the type of curve used to control the dimmer with this convention linear ON OFF dimmer off if zero 100 if different than O first channel of a 16 bit circuit for high level program use constantly at patch level independently from master and black outs Ono Adding 10 the Mater inhibitor is selected as follows 10 linear No Master 11 ON OFF No Master 12 first channel of a 16 bit circuit No Master This is a pseudo code representation of the DMXPTCSND function flow FOR i 1 TO dmxsize dmxch i MAX dmxchan dmxpatch i dmxchanl dmxpatch i dmxchan2 dmxpatch i dmxchan3 dmxpatch i dmxchan4 dmxpatch i dmxgr dmxpatch i IF dmxcurve i lt 10 THEN dmxch i dmxch i mast 100 IF dmxcurve i 3 THEN dmxch i 255 dmxch i dmxch i dmxpatchlev 100 IF dmxch i gt 255 THEN dmxch i 255 IF dmxcurve i 1 AND dmxch i lt gt 0 THEN dmxch
28. se failed yy lt gt 0 logged errors dmxtype 32 bit pointer to DMXType valid on DMXStatus 0 for DMXPlus 0 Base 1 Pro for DMXAdp O std cable 1 Intelligent Cable ak k k KKK k k k k k k KK k k k k k k k k k k k k k k k kkk k k k kkk kk kk kkk kk k kkk kkk kk kkk kkk kkk ke ke ke ke DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 9 of 26 2 6 DMXCAPTURE The DMXCAPTURE function is used to enter Slave Mode if previously driving DMX line and capture the first packet detected on the DMX line In this way the state of the DMX line may be monitored and static scenes may be captured and stored in the high level program The capturing performance is in the range of 15 packets sec therefore it is good enough for a realistic DMX monitor but is not meant for capture playback of crossfades from an external console As usually the Ipt parameter specifies the port where the DMX interface is plugged The dmxstart return parameter reports the value of the DMX Startcode of the captured packet normally 0 fro dimmer applications The dmxpkt value reports the acquired number of channels from 0 to 512 where a value of 0 indicates a capture timeout i e no DMX signal found The dmxchan parameter is a pointer to the channel buffer that must be an array of 32 bit words skkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk DMXCAPTURE Ipt dmxstart dmxpkt dmxchan function Captures a packet from
29. t pointer to DMX Patch Level array 512 dwords dmxcurve 32 bit pointer to DMX Curve array 512 dwords output parameters none skk KKK kk kkk kk kk k kkk k ke ehe hehe ke ke ehe hehe kk kk kkk kkk ehe ke heck kk ke ke heck eee ke kc eek eec ek ke ke DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 13 of 26 2 9 DMXIDENT The DMXIDENT function is used to report a cumulative set of information regarding the DMX interface hardware This function is used to handle the historical differences between the different models of DMX hardware produced by Digimedia and supports different protection schemes to link software features to a specific model or serial number The usual Ipt parameter specifies the parallel port The dmxstatus is the return variable indicating inquiry success 0 returned or te occurrence of any problem during hardware inquiry The function when successfully completed dmxstatus 0 reports the information about the interface in the dmxhard dmxrev dmxsubrev serialno variables in this way VARIABLE MEANING J jRETURNED VALUES hardware type 0 none 1 DMXPlus Base 2 DMXPlus Pro 3 DMXAdp dmxrev firmware revision 1 Ascii character dmxsubrev firmware sub revision 2 Ascii characters serialno serial number 5 digit BCD nulls if no s n This is the function prototype ARK KKK KKK KKK KKK KKK KK KKK KKK KKK KKK KKK RRR KKK RRR ee ke ke heck ee ke ke ke eek ke ek DMXIDENT Ipt dmxsta
30. tus dmxhard dmxrev dmxsubrev serialno function Used to identify the DMX interface hardware connected to LPT q setting dmxplus flag accordingly to support run time selection of DMX hardware This is the proper function sequence DMXSense to verify hardware presence DMXIdent only if Sense successful DMxXInit to setup library input parameters Ipt 32 bit pointer to Lpt Port address output parameters DMXStatus 0000h ParDmx present no errors logged xxyy errors where xx lt gt 0 Sense failed yy lt gt 0 logged Send PtcSnd errors DMXHard 32 bit pointer to DMX Interface Hardware type encoding 0000h no hardware demo mode 0001h DMXPlus Base 0002h DMXPlus Pro 0003h DMXAdp DMXRev 32 bit to Hardware Revision code 1 Ascii m DMXSubRev 32 bit pointer to Hardware SubRevision code 2 Ascii serialno 32 bit serial number in BCD format if present skkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk 5 DMXPLUS DLL OEM User s Manual V1 1 Digimedia MLS 1997 1998 Page 14 of 26 2 10 DMXREV The DMXREV function is used to report the full revision template of the DMX interface firmware revision This is normally not required since DMXIDENT is used to report firmware revision subrevision As with DMXIDENT this function let the DMX interface be used as a hardware key DMXREV may be only called when in Slave Mode i e it must be called before the DMXDRIVE function Calling DMXR
Download Pdf Manuals
Related Search