AmbientOrb Task

AmbientOrb

Description

Invokes the AmbientOrb listener.

This Ant task listens for build events and sends the status to your Ambient Orb. You can modify your orb colors, animations, and comments sent your Orb. E.g. - You may monitor the software quality over a period of time.

The task requires at least the Ambient Orb 0.5 version.

Parameters

Attribute	Description	Required
listener	The fully qualified location of the Orb Listener class.	No
query	URI at Ambient Devices to send Orb messages	No, default is "http://myambient.com:8080/java/my_devices/submitdata.jsp"
deviceId	Unique device ID assigned by Ambient Devices for your Orb.	Yes
colorPass	A color (or number; 0-36) to set the Orb to if the build passes.	Yes
colorFail	A color (or number; 0-36) to set the Orb to b if the build fails.	Yes
animationFail	An animation type (or number; 0-9) to set the Orb to if the build fails.	No
animationPass	An animation type (or number; 0-9) to set the Orb to if the build passes.	No
commentPass	The comment when the build passes. Spaces must be separated using a + sign	No
commentFail	The comment when the build fails. Spaces must be separated using a + sign.	No

Examples

Animation Index Numbers

Index	Animation
0	none
1	very slow
2	slow
3	medium slow
4	medium
5	medium fast
6	fast
7	very fast
8	crescendo
9	heartbeat

Color Index Numbers

Index	Color
0	red
1	light red
2	dark orange
3	orange
4	light orange
5	dark yellow
6	yellow
7	lime green
8	pale green
9	green -3
10	green -2
11	green -1
12	green
13	green + 1
14	green + 2
15	pale aqua
16	aqua
17	dark aqua
18	cyan
19	dark cyan
20	light blue
21	sky blue
22	blue -2
23	blue -1
24	blue
25	deep blue
26	very deep blue
27	violet
28	purple
29	light purple
30	magenta
31	magenta + 1
32	magenta + 2
33	magenta + 3
34	magenta + 4
35	magenta + 5
36	white

This registers the AmbientOrb task to listen for build events. When a build passes or fails, a message is sent to the Orb to change the color to green (12) when passing and red (0) when failing.

<target name="registerOrb">
  <path id="orb.class.path">
    <fileset dir="${ant.home}">
      <include name="ambientorb-0.5.jar"/>
    </fileset>
  </path>
  <taskdef classname="org.qualitylabs.ambientorb.ant.OrbTask" name="orb" classpathref="orb.class.path"/>
  <orb listener="org.qualitylabs.ambientorb.ant.OrbListener" 
    device="AAA-99A-AAA" 
    colorPass="green" 
    colorFail="red"
	animationFail="heartbeat" 
    animationPass="none" 
    commentPass="The+build+passed"
    commentFail="Build+Failure!!" />
</target>

To change the color of the Orb without registering the task, use an example similar to the one below. This will change the color of the Orb to green -3 (9) regardless of the event

  <orb deviceId="AAA-99A-AAA"
    colorPass="green"
    colorFail="red"
    commentPass="NO+LISTENER+The+build+passed"
    commentFail="NO+LISTENER+Build+Failure!!" />