Renard Diagnostic Firmware Instructions - Revision history

Ravinglunatic: /* Renard Diagnostic Firmware */

2013-02-28T12:24:57Z

Renard Diagnostic Firmware

← Older revision		Revision as of 12:24, 28 February 2013
Line 3:		Line 3:
	:These instructions apply to the Renard Diagnostic Firmware contained in the file: [[Media:Ren-diag-beta--20090117.asm \| Ren-diag-beta--20090117.asm]]		:These instructions apply to the Renard Diagnostic Firmware contained in the file: [[Media:Ren-diag-beta--20090117.asm \| Ren-diag-beta--20090117.asm]]

	:These instructions were written with the Renard SS board design in mind but can apply to any ~~normal~~ Renard ~~based~~ controller.		:These instructions were written with the Renard SS board design in mind but can apply to any PIC16F688 based Renard controller.

	===Purpose:===		===Purpose:===

Ravinglunatic: /* Purpose: */

2013-02-28T12:21:20Z

Purpose:

← Older revision		Revision as of 12:21, 28 February 2013
Line 6:		Line 6:

	===Purpose:===		===Purpose:===
	:The Renard Diagnostic Firmware has been developed in an effort to provide the user with a troubleshooting tool to help isolate problems on Renard ~~based~~ controllers. This firmware will help in finding some problems but it isn’t guaranteed to find all possible problems.		:The Renard Diagnostic Firmware has been developed in an effort to provide the user with a troubleshooting tool to help isolate problems on PIC16F688 based Renard controllers. This firmware will help in finding some problems but it isn’t guaranteed to find all possible problems.

	===Features:===		===Features:===

Ravinglunatic: Undo revision 5966 by Ravinglunatic (Talk)

2011-12-03T05:36:58Z

Undo revision 5966 by Ravinglunatic (Talk)

← Older revision		Revision as of 05:36, 3 December 2011
Line 198:		Line 198:
	:#*Check data cables		:#*Check data cables
	:#*Check/replace RS485 chip		:#*Check/replace RS485 chip
	:#*Check solder joints on input connector, RS485 chips and associated components		:#*Check solder joints on input connector, RS485 chips and associated components <br> <br>
	<br> <br>
	:#If either '''FE LED''' (channel 7) or '''OE LED''' (channel 8) come on, indicates data is reaching the PIC but is also causing errors. Try the following:		:#If either '''FE LED''' (channel 7) or '''OE LED''' (channel 8) come on, indicates data is reaching the PIC but is also causing errors. Try the following:
	:#*Check your VIXEN settings, they should be:		:#*Check your VIXEN settings, they should be:
Line 213:		Line 212:
	:#*Check/replace RS485 chip		:#*Check/replace RS485 chip
	:#*Check solder joints on input connector, RS485 chips and associated components		:#*Check solder joints on input connector, RS485 chips and associated components


	=='''Related Links'''==		=='''Related Links'''==

Ravinglunatic: /* Simple Communications Test Fails: */

2011-12-03T05:35:10Z

Simple Communications Test Fails:

← Older revision		Revision as of 05:35, 3 December 2011
Line 199:		Line 199:
	:#*Check/replace RS485 chip		:#*Check/replace RS485 chip
	:#*Check solder joints on input connector, RS485 chips and associated components		:#*Check solder joints on input connector, RS485 chips and associated components
	~~:#*Perform Simple Wrap-around Test to isolate problem to board or connections~~ <br> <br>		<br> <br>
	:#If either '''FE LED''' (channel 7) or '''OE LED''' (channel 8) come on, indicates data is reaching the PIC but is also causing errors. Try the following:		:#If either '''FE LED''' (channel 7) or '''OE LED''' (channel 8) come on, indicates data is reaching the PIC but is also causing errors. Try the following:
	:#*Check your VIXEN settings, they should be:		:#*Check your VIXEN settings, they should be:
Line 213:		Line 213:
	:#*Check/replace RS485 chip		:#*Check/replace RS485 chip
	:#*Check solder joints on input connector, RS485 chips and associated components		:#*Check solder joints on input connector, RS485 chips and associated components


	=='''Related Links'''==		=='''Related Links'''==

Ravinglunatic: /* Renard Diagnostics Firmware */

2011-12-02T04:11:43Z

Renard Diagnostics Firmware

← Older revision		Revision as of 04:11, 2 December 2011
Line 1:		Line 1:
	=='''Renard ~~Diagnostics~~ Firmware'''==		=='''Renard Diagnostic Firmware'''==

	:These instructions apply to the Renard ~~Diagnostics~~ Firmware contained in the file: [[Media:Ren-diag-beta--20090117.asm \| Ren-diag-beta--20090117.asm]]		:These instructions apply to the Renard Diagnostic Firmware contained in the file: [[Media:Ren-diag-beta--20090117.asm \| Ren-diag-beta--20090117.asm]]

	:These instructions were written with the Renard SS board design in mind but can apply to any normal Renard based controller.		:These instructions were written with the Renard SS board design in mind but can apply to any normal Renard based controller.

	===Purpose:===		===Purpose:===
	:The Renard ~~Diagnostics~~ Firmware has been developed in an effort to provide the user with a troubleshooting tool to help isolate problems on Renard based controllers. This firmware will help in finding some problems but it isn’t guaranteed to find all possible problems.		:The Renard Diagnostic Firmware has been developed in an effort to provide the user with a troubleshooting tool to help isolate problems on Renard based controllers. This firmware will help in finding some problems but it isn’t guaranteed to find all possible problems.

	===Features:===		===Features:===
Line 22:		Line 22:
	[[image: PIC16F688 Pinout.jpg\|300px\|center]]		[[image: PIC16F688 Pinout.jpg\|300px\|center]]
	<center>PIC16F688 Pin Assignments</center>		<center>PIC16F688 Pin Assignments</center>


	=='''Description of Test:'''==		=='''Description of Test:'''==

Ravinglunatic: Created page with '=='''Renard Diagnostics Firmware'''== :These instructions apply to the Renard Diagnostics Firmware contained in the file: [[Media:Ren-diag-beta--20090117.asm | Ren-diag-beta--2…'

2011-12-02T04:11:07Z

Created page with '=='''Renard Diagnostics Firmware'''== :These instructions apply to the Renard Diagnostics Firmware contained in the file: [[Media:Ren-diag-beta--20090117.asm | Ren-diag-beta--2…'

New page

=='''Renard Diagnostics Firmware'''==

:These instructions apply to the Renard Diagnostics Firmware contained in the file: [[Media:Ren-diag-beta--20090117.asm | Ren-diag-beta--20090117.asm]]

:These instructions were written with the Renard SS board design in mind but can apply to any normal Renard based controller.

===Purpose:===
:The Renard Diagnostics Firmware has been developed in an effort to provide the user with a troubleshooting tool to help isolate problems on Renard based controllers. This firmware will help in finding some problems but it isn’t guaranteed to find all possible problems.

===Features:===
:*Performs a Channel Output Test
:*Performs Renard Health Monitoring
:*Performs a simple Communication Test

===Diagnostic Indicators:===
:'''HB LED''' (Channel #2) – Blinks to indicate that the PIC is operating correctly.
:'''ZC LED''' (Channel #5) – Blinks to indicate that the PIC is sensing the Zero Crossing (ZC) signal.
:'''SD LED''' (Channel #6) – ON steady while VIXEN data is being received correctly.
:'''FE LED''' (Channel #7) – ON when the PIC detects a Framing Error (FE) while receiving VIXEN data.
:'''OE LED''' (Channel #8) – ON when the PIC detects an Overrun Error (OE) while receiving VIXEN data.

[[image: PIC16F688 Pinout.jpg|300px|center]]
<center>PIC16F688 Pin Assignments</center>

=='''Description of Test:'''==

===Channel Output Test===
:This test exercises the PICs ability to turn ON/OFF the outputs. This test is especially useful for Renard based boards that have on-board channel LEDs (ie: Ren64). Boards without on-board LEDs can still be tested by hooking up lights to the board outputs like normal.

:This test is performed before the PIC starts testing for the Zero Cross signal, so is independent from the ZC signal.

:The test sequence is as follows:
::*All channels ON for approx. 2 seconds
::*All channels OFF for approx. 2 seconds
::*Channel 1 turns ON for approx. 1 second then turns OFF
::*Channel 2 ('''HB LED''') turns ON for approx. 1 second then turns OFF
::*Channel 3 turns ON for approx. 1 second then turns OFF
::*Channel 4 turns ON for approx. 1 second then turns OFF
::*Channel 5 ('''ZC LED''') turns ON for approx. 1 second then turns OFF
::*Channel 6 ('''SD LED''') turns ON for approx. 1 second then turns OFF
::*Channel 7 ('''FE LED''') turns ON for approx. 1 second then turns OFF
::*Channel 8 ('''OE LED''') turns ON for approx. 1 second then turns OFF
::*: (The above test sequence repeats three times)

:Why is this test useful?
::*Occurs before testing for the Zero Cross
::*Verifies operation of on-board LEDs
::*Verifies operation of channel outputs

===Renard Health Monitoring Routine ===
:This routine is the “meat” of the diagnostics firmware. This routine checks for a good Zero Crossing (ZC) signal and shows general health status indication by blinking a Heart Beat (HB). The HB simply shows that the PIC is operating correctly, has good power and a good clock signal.

:Test Indications are as follows:
::'''HB LED''' (Channel #2) blinks to indicate that the PIC is operating correctly.
::'''ZC LED''' (Channel #5) blinks to indicate that the PIC is sensing the Zero Crossing (ZC) signal.

:Why is this test useful?
::*Blinking HB indicates that the PIC has good power and a usable clock signal
::*Blinking ZC indicates a usable ZC signal present at the PIC

===Simple Communication Test ===
:This routine checks to see if the PIC is receiving valid Renard data from the computer.

:This test requires you to run a VIXEN sequence. To be able to get good results with this test, you need a sequence that has many changes occurring, a long dimming ramp works great. Do not expect any other indications except those listed below, the sequence data is not passed to any other chips (if installed).

:Test Indications are as follows:

::When no VIXEN data is being sent to the PIC:
:::'''SD LED''' (Channel #6) is OFF
:::'''FE LED''' (Channel #7) is OFF
:::'''OE LED''' (Channel #8) is OFF

::When VIXEN data is sent to the PIC:
:::'''SD LED''' (Channel #6) comes on steady while error-free VIXEN data is being received.
:::'''FE LED''' (Channel #7) comes on if the PIC detects a Framing Error (FE) while receiving VIXEN data.
:::'''OE LED''' (Channel #8) comes on if the PIC detects an Overrun Error (OE) while receiving VIXEN data.

:Why is this test useful?
::*When properly performed, the data check will confirm that VIXEN data is getting to the PIC correctly

=='''How to use the Diagnostic Firmware:'''==
<ol>
<li> Re-flash a PIC16F688 with the diagnostics firmware. If you need help with this step, check the info in this [http://www.doityourselfchristmas.com/forums/showthread.php?t=490 thread.]
 

<li> Make sure power is removed from the Renard board being checked
 

<li> Insert the diagnostic PIC into the first PIC position
:*U6 on Renard SS boards
:*U10 on Renard 64 boards
:*U1 on Renard 16 (XMUS) boards
:*PIC on left side for Renard 24 (fkostyun)
 

<li> If the board under test doesn’t have any on-board LEDs to use during diagnostics then hook up lights to the outputs
 

<li> Hook up the data cable coming from the computer running VIXEN to the board under test. Do not run a sequence yet.
:*J2 or JDP1 on Renard SS boards
:*J4 or J22 on Renard 64 boards
:*IN on Renard 16 (XMUS) boards
:*COMM IN on Renard 24 (fkostyun)
 

<li> If the board has a RS232 jumper, put it in the correct position for the type of data coming from the computer.
:*Renard SS boards; JP1 installed for RS232, removed for RS485
:*Renard 64XC boards; JP1 installed for RS232, removed for RS485
 

<li> Renard SS boards – Install a jumper on JP3
 

<li> Power up the Renard board
 

<li> If the Channel Output Test will run automatically and the following should happen:
:*All channels ON for approx. 2 seconds
:*All channels OFF for approx. 2 seconds
:*Channel 1 turns ON for approx. 1 second then turns OFF
:*Channel 2 ('''HB LED''') turns ON for approx. 1 second then turns OFF
:*Channel 3 turns ON for approx. 1 second then turns OFF
:*Channel 4 turns ON for approx. 1 second then turns OFF
:*Channel 5 ('''ZC LED''') turns ON for approx. 1 second then turns OFF
:*Channel 6 ('''SD LED''') turns ON for approx. 1 second then turns OFF
:*Channel 7 ('''FE LED''') turns ON for approx. 1 second then turns OFF
:*Channel 8 ('''OE LED''') turns ON for approx. 1 second then turns OFF
:*: (The above test sequence repeats three times)
 

<li> After the Channel Output Test, the Renard Health Monitoring routine starts running,
:*Channel 2 ('''HB LED''') starts blinking (no defined interval, but approx 1 sec ON/OFF)
:*:If you got this far then there should be no reason for the '''HB LED''' not to be working
 
:*Channel 5 ('''ZC LED''') should also be blinking (if not the ZC signal is missing or incorrect)
:*:If the '''ZC LED''' is not blinking then you need to troubleshoot the problem before proceeding
 

{| style="width:70%; font-size:100%" border="1" cellspacing="0" cellpadding="10" align="center"
| If you have gotten to this point then your Renard board is working well and there is only one thing left to check. You’ll need to run a VIXEN sequence to see if the board will respond correctly. To get good results, the VIXEN sequence should have many changes occurring since VIXEN only sends data when a change occurs in the sequence. A dimming ramp will work very nicely.
|}
 

<li> Start a VIXEN sequence
:*Channel 6 ('''SD LED''') should come on steady when VIXEN data is received by the PIC.
:*Channel 7 ('''FE LED''') and Channel 8 ('''OE LED''') should remain off.
</ol>


<blockquote> <center> If the diagnostics responded correctly then you are done with the diagnostics. 
If not, then you need to start troubleshooting. Good Luck!</center></blockquote>


=='''Simplified Troubleshooting with the Diagnostic Firmware:'''==

===Channel Output Test Fails:===
:#If only Channel #1 comes ON and stays ON
:#*Common indication that the PIC is blank, re-flash the PIC 
:#If no on-board LEDs or output channels respond correctly
:#*Check PIC power and/or programming
:#*External Oscillator may be bad, try running the diagnostics using internal oscillator 
:#If on-board LEDs don’t respond correctly but the output channels do
:#*On-board LEDs might be installed backwards
:#*If a resistor network is used for the on-board LEDs, it might be installed backwards
:#*Check the solder joints for on-board LEDs and associated resistor path(s) 
:#If on-board LEDs respond correctly but output channels do not
:#*Check AC power connections
:#*Check optos for correct installation
:#*Check solder joints for optos/resistors/triacs/terminals

===Renard Health Monitoring Routine Fails:===
:#If only Channel #1 comes ON and stays ON
:#*Common indication that the PIC is blank, re-flash the PIC 
:#If '''HB LED''' (channel 2) is not blinking
:#*Check PIC power and/or programming
:#*External Oscillator may be bad, try running the diagnostics using internal oscillator 
:#If '''ZC LED''' (channel 5) is not blinking
:#*Check the Zero Crossing circuitry, each Renard board is different so check the wiki for details

===Simple Communications Test Fails:===
:#If '''SD LED''' (channel 6), '''FE LED''' (channel 7) and '''OE LED''' (channel 8) do not come ON when VIXEN sequence ran, indicates that no data is reaching the PIC.
:#*Check data cables
:#*Check/replace RS485 chip
:#*Check solder joints on input connector, RS485 chips and associated components
:#*Perform Simple Wrap-around Test to isolate problem to board or connections 
:#If either '''FE LED''' (channel 7) or '''OE LED''' (channel 8) come on, indicates data is reaching the PIC but is also causing errors. Try the following:
:#*Check your VIXEN settings, they should be:
:#**Protocol Version: 1
:#**COM1 (or whichever COM port you are connected to)
:#**Baud: 57600 (default firmware value, if firmware is changed then this needs to be changed to match the firmware)
:#**Parity: None
:#**Data bits: 8
:#**Stop bits: One
:#**Hold port open during the duration of the sequence execution: Checked
:#*Check data cable connecting the computer running VIXEN to the Renard board.
:#**Check the wiki to make sure that you have cable wired correctly: [[Renard Data Cables]]
:#*Check/replace RS485 chip
:#*Check solder joints on input connector, RS485 chips and associated components

=='''Related Links'''==
:[[Renard Main Page]]

:[[Renard Firmware]]

:[[Troubleshooting_Guide_The_Renard_SS8 | Troubleshooting Guide The Renard SS8]]

:[[Troubleshooting_Guide_The_Renard_SS16 | Troubleshooting Guide The Renard SS16]]

:[[Troubleshooting_Guide_The_Renard_SS24 | Troubleshooting Guide The Renard SS24]]

:[[Troubleshooting_Guide_Renard_64XC | Troubleshooting Guide The Renard 64XC]]

:[[Vixen|VIXEN]]

:[[Glossary | Glossary of DIYC Terms]]

:[http://en.wikipedia.org/wiki/Electronic_symbol Electronic Symbols]

[[Category:DIYC Controllers]]
[[Category:Renard]]
[[Category:Renard SS8]]
[[Category:Renard SS16]]
[[Category:Renard SS24]]
[[Category:Renard 64XC]]
[[Category:DIYC Index]]