Supported attributes in FPP <spot>:

xmlfile	xmlfile=floorplan.xml	read plugin parameters from this XML file
setupMode	setupMode=1	initiates setup mode - see details below

The following parameters can be updated dynamically from FPP ("external.floorplan.name=value"):

visible	visible=T	0 or 1, any other value toggles visibility
alpha	alpha="0.60"	plugin alpha when not mouse-over, default=1.0
scale	scale="0.75"	fixed plugin scale, default=1.0
	or
	scale="35%"	plugin height in percent of pano height
goCamera	goCamera=Salon	selects camera and executes FPP command
selectCamera	selectCamera=Dining Room	selects camera WITHOUT executing FPP command
bump	bump=Kitchen	bump camera image to make it stand out
xmlfile	xmlfile=floorplan.xml	read new plugin parameters from this XML file

Supported parameters/attributes in plugin xml file:

NOTES:
Parameter names are not case sensitive ("XMLFile" is equal to xmlfile"). Parameter values, on the other hand, will be saved
exactly as written.

If you want all your camera icons to be the same, then you only have to specify the "camUrl" attribute in the <floorplan> tag. And the same goes for the "currentCamUrl" and "visitedUrl" attributes. If you want a house or a floor to have different camera icons, then you specify it in the <building> or <floor> tags. And if you want a single camera to have its own icon, then you specify it in the <camera> tag.

In each floor you can also include a number of buttons with the <button> tag. They can be used to execute any FPP commands to change floor or building or select a certain camera or whatever is needed.

When setting scale to a percentage value, the scaling of the floor image will never be higher than 1:1.

When you use the "goCamera=camera_id" and "selectCamera=camera_id" parameters, it is sufficient to write only the camera_id if it is unique. Otherwise you have write "goCamera=floor_id:camera_id", and if that isn't unique you have to write "goCamera=building_id:floor_id:camera_id".

The "bump=camera_id" command can for example be used at a hotspot mouse-over to show which camera will be selected when the hotspot is clicked.

If you are using the &" characters inside the "command" parameters in the xml file, you have to encode them as follows:

The setup mode is a help to get your cameras into the proper positions. Just write setupMode="1" in the tag and start up the pano. All the cameras in your xml file will show as usual, but when you click on them, the camera xml tag will be shown in a text box. And when you drag the camera, the text box will show the updated position. New cameras can be added by clicking on the floorplan, and cameras can be deleted by holding down the Alt-key while clicking on them. You can change the generated camera id in the text box, but not any of the other parameters. Note that your xml file will not be changed in any way by the plugin. You have to copy the text in the box and paste it into your text editor. This is just an easy way to get your camera positions.

Example XML file:

<?xml version = '1.0'?>
<floorplan
   salign="TC" 
   margin="-150:15" 
   alpha="" 
   scale="0.6" 
   visible="1" 
   shadow="1" 
   currentCamUrl="img/cam1.png" 
   visitedCamUrl="img/camv.png" 
   onOver="global.expandFloor" 
   onOut="global.shrinkFloor" 
>
   <radar visible="1" size="40" color="#8080E0" fillAlpha="0.15" />
   <tooltip visible="1" textColor="#505050" textSize="11" bgColor="#E0E0C0" borderColor="#000000" />
   <building id="My house" camUrl="img/cam2.png">
      <floor id="My apartment" url="img/apartment.png">
         <camera id="Entry" pos="145:195" offset="55" onClick="global.goHome6()" selected="1" />
         <camera id="Kitchen" pos="33:225" offset="-53" tooltipY="-22" onClick="global.goHome1()" />
         <camera id="Livingroom" pos="20:35" offset="113" tooltipUrl="img/ttlivingroom.jpg" onClick="global.goHome2()" />
         <camera id="Hallway" pos="160:35" offset="-151" onClick="global.goHome3()" />
         <camera id="Bedroom" pos="305:35" offset="-53" tooltipUrl="img/ttbedroom.jpg" tooltipX="-90" onClick="global.goHome4()" />
         <camera id="Guestroom" pos="20:100" offset="0" onClick="global.goHome5()" />
         <button id="Get lost" pos="308:233" url="img/black_x.png" onClick="global.buttonCommand1()" />
      </floor>
   </building>
   <building id="Eniro" camUrl="img/cam2.png">
      <floor id="Floor 5" url="img/floor5.png">
         <camera id="Reception" pos="185:190" offset="-150" onClick="global.goWork1()" />
         <camera id="Lunch area" pos="140:60" offset="118" onClick="global.goWork2()" />
         <camera id="Staircase" pos="172:125" offset="98" tooltipUrl="img/ttstaircase.jpg" onClick="global.goWork3()" />
      </floor>
      <floor id="Floor 8" url="img/floor8.png" camUrl="img/cam2.png">
         <camera id="My desk" pos="260:230" offset="-52" camUrl="img/camb.png" onClick="global.goWork4()" />
         <camera id="West Gallery" pos="175:190" offset="-88" tooltipUrl="img/ttwest.jpg" onClick="global.goWork5()" />
         <camera id="East Gallery" pos="160:60" offset="-85" onClick="global.goWork6()" />
      </floor>
   </building>
</floorplan>
						

Version history: