Top Banner
Control4/HomeKit Appliance User Manual i User Manual June 2017 Version 1.0.3 Varietas Software, LLC http://www.varietassoftware.com/control4
12

Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

Aug 07, 2018

Download

Documents

ngobao
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
Page 1: Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

Control4/HomeKit Appliance User Manual

i

UserManual

June2017

Version1.0.3

VarietasSoftware,LLC

http://www.varietassoftware.com/control4

Page 2: Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

Control4/HomeKit Appliance Quick Start

ii

DocumentRevisions

Date Version Number Document Changes

01/08/2017 1.0.1 InitialDraft

4/20/2017 1.0.2 UpdatedtodocumentControl4driver1.5andfirmware1.0.4

6/13/2017 1.0.3 UpdatedtodocumentControl4driver1.12andfirmware1.0.8

Page 3: Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

Control4/HomeKit Appliance Quick Start

iii

TableofContents

QuickStartGuide.........................................................................................................................................................................iIntroduction.................................................................................................................................................................................41.1...ScopeandPurpose..........................................................................................................................................................41.2...Prerequisites......................................................................................................................................................................41.3...Disclaimer...........................................................................................................................................................................41.4...ProcessOverview.............................................................................................................................................................5

LoggingIntoTheAppliance..................................................................................................................................................6ApplianceLicense......................................................................................................................................................................6ConfiguringTheDirectorConnection...............................................................................................................................7HomebridgeConfiguration....................................................................................................................................................7Control4DeviceList.................................................................................................................................................................8AdvancedConfiguration.......................................................................................................................................................11AddingTheApplianceToHomeKit..................................................................................................................................12Support.........................................................................................................................................................................................12

Page 4: Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

Control4/HomeKit Appliance User Manual

4

Introduction1.1 ScopeandPurposeTheControl4/HomeKitapplianceisanetworkbridgethatmakesControl4hardwareavailabletoApple’sHomeKitecosystem.

ThisUserGuideisintendedtoassistageneraluserinconfiguringControl4devicesforHomeKituse,viatheappliance.

1.2 Prerequisites1. TheVarietasSoftwareHomebridgedrivermustbeinstalledinyourControl4project

(availablefromHouseLogix,contactyourdealerfordetails).Onlyasinglecopyofthedriverisrequired.YouwillneedtoprovideyourdirectorIPaddressandthenetworkportthedriverisconfiguredforduringtheappliancesetupprocess.

2. AwiredEthernetconnectionavailablesomewhereonyournetwork.Thephysicallocationoftheappliancedoesnotmatter.

3. ADHCPserverprovidingdynamicaddressesonyournetwork.Thisisthemostcommonnetworkconfigurationformosthomes.IfyouhavenoDHCPserverandanentirelystaticnetwork,youwillneedtodosomeadvancedconfiguration.ContactVarietasSoftwarefordetails.

4. YourControl4controllerconfiguredastheDirectormustbeallocatedastaticIPaddress.Thiscanbecompletedanumberofways.Ifyouneedhelpwiththis,pleasecontactyourdealer.

1.3 Disclaimer

Theappliancesoftwarereliesonhomebridge(https://github.com/nfarina/homebridge),anopensourceplatformtoenableHomeKitcommunicationwithnon-HomeKitdevices.VarietasSoftwarechargesonlyfortheappliancehardwareandtheweb-basedconfigurationsoftwaredevelopedspecificallyfortheappliance.Homebridge,andtheVarietasSoftwareControl4homebridgeplugin,arefreelyavailableopensourcecomponents.VarietasSoftwareisnotaffiliatedwithApple,Control4,orhomebridgeinanyway.UseofanytrademarkedtermsisentirelydescriptiveandisnotintendedtoimplyanyendorsementorrelationshipwithApple,Control4,orhomebridge.

Thissoftwareisprovided"asis"andanyexpressedorimpliedwarranties,including,butnotlimitedto,theimpliedwarrantiesofmerchantabilityandfitnessforaparticularpurposearedisclaimed.Innoeventshalltheregentsorcontributorsbeliableforanydirect,indirect,incidental,special,exemplary,orconsequentialdamages(including,butnotlimitedto,procurementofsubstitutegoodsorservices;lossofuse,data,orprofits;orbusinessinterruption),howevercaused,andonanytheoryofliability,whetherincontract,strictliability,ortort(includingnegligenceorotherwise)arisinginanywayoutoftheuseofthissoftware,evenifadvisedofthepossibilityofsuchdamage.

Page 5: Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

Control4/HomeKit Appliance Quick Start

5

1.4 ProcessOverview

Formostusers,installationandconfigurationoftheapplianceisasimplesetofsteps:

• PlugtheapplianceintoyournetworkwithanEthernetcable(notprovided)

• PlugtheapplianceintoapoweroutletusingtheprovidedACadapter.

• UseSafari,Firefox,orIE(Chromenotyetsupported)togotohttp://homebridge.local

• Entertheusernameandpassword,whenprompted(default:homebridge/h0m3br1dg3)

• ProvidetheIPofyourdirectorandtheportoftheControl4Homebridgedriver

• Click“ImportConfigFromControl4”

• Confirmtheimporteddevicelist

• Clickon“RestartHomebridge”

Detailedhelpformostapplianceoptionsandvaluesisavailablebyclickingthe(?)foundinvariouslocationsonthemainpage.

Page 6: Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

QuickStart

6

LoggingIntoTheApplianceOpenyourpreferredwebbrowserandgototheURLhttp://homebridge.local.Aloginpromptwillbedisplayed.Entertheusernameandpasswordfortheappliance(default:homebridge/h0m3br1dg3).

Figure1:Loggingintotheappliance

Uponsuccessfullogin,themainapplianceconfigurationpagewillbedisplayed.

ApplianceConfigurationIfyoupurchasedyourappliancedirectlyfromVarietasSoftwareorfromoneofourdistributors,thenyourappliancewillcomewithalicensepre-installed.

Figure2–Theapplianceconfiguration

Inmostcases,youwillnotneedtoconfigureanythinginthissection.Ifyourappliancedoesnothavealicense,orifyourlicensebecomesinvalid,thelicensestatewillchangetoindicatetheissue,andnoneofthestandardconfigurationoptionswillbepresented.Youwillbepromptedtoenteravalidlicensekey.EnterthevalueprovidedbyVarietasSoftwareoryourdealertocontinue.

Page 7: Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

QuickStart

7

ConfiguringTheDirectorConnectionThefastestwaytoconfiguretheapplianceistoimportthecompleteControl4configurationfromthedirector.ScrolldownintheconfigurationpagetotheDirectorLocationsection.EntertheIPAddressofyourControl4controllerconfiguredasthedirectorandtheHomebridgedriverportyourdealerconfigured.Ifyourdealeralsoenabledsecurityonthedriver,thenenterthesharedsecretvalue,providedbyyourdealer,andchecktheSecuritybox.

Figure3:Configuringthedirectorlocation

Onceyouhavesavedthedirectorconfiguration,theversionnumberoftheControl4driverinstalledinyourprojectwillappearunder“Control4DriverVersion”.Ifthisvaluedoesnotappear,thenthereiseitheraconfigurationissuewiththeControl4driver(youlikelyneedtospecifyadifferentport),oryouhaveenteredthedetailsincorrectlyintheconfigurationportal.Donotproceedwithsetupuntilyouseethedriverversionlisted.

Ifyouarereadytoimportthedirectorconfiguration,clickon“ImportConfigFromControl4”.Ifyouareenteringupdatedvaluesforfutureuse,clickon“SaveDirectorConfig”.

Duringtheimportprocess,theappliancewillquerytheControl4systemforsupporteddevices.Anydevicesdetectedthatarenotalreadyintheapplianceconfigurationwillbeimported.Theconfigurationforanydevicesalreadypresentwillbeleftalone.

HomebridgeConfigurationTheHomebridgeConfigurationsectioncontainsbasicinformationaboutyourappliancesetup.Detailedstatusisavailableindicatingwhenhomebridgewaslastrestartedandtheinstalledandlatestavailableversionsofhomebridge,thehomebridgeControl4plugin,andtheappliancefirmware.Ifupdatesareavailable,anupdatebuttonwillbedisplayed.Donotdisconnecttheappliancefrominternetorpowerwhileitisupgradingitsinternalsoftware.

Inadditiontothesystemstatusthefollowingglobalhomebridgeconfigurationoptionsareavailable:

• Bridge/HomeDescription-Thesevaluesarerequired,butarefordisplaypurposesonly.

Page 8: Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

QuickStart

8

• HomebridgeServerPort–Thenetworkportthehomebridgeserverwilluseontheappliance.Youshouldnotnormallyneedtoalterthisvalue.

• HomeKitPIN–ThisisthevalueyouwillenterintoHomeKitwhenyouareaddingtheappliancetoHomeKitonyourdevice.

• HomeKitUserName–Displayedforinformationonly.Youshouldnotneedtoalterthisvalue.

• EnableAdvancedConfigurationOptions–Foradvancedusersonly.Theoptionsmadeavailablebycheckingthisboxprovidegreaterdirectcontrol,butmaycausehomebridgetobecomeunreachable.Useatyourownrisk.

Figure3:Homebridgeconfiguration

Youmayalso:

• RestartHomebridge-Restartthehomebridgesoftware,whichwillapplyanychangestotherunningappliance

• SaveHomebridgeConfig-Saveanychangestothehomebridgedevicelistenteredinthesectionsbelowtotheapplianceconfiguration.

• ViewHomebridgeLogs–Viewandcopy/pastethelatesthomebridgelogoutput.Thismayhelpindebuggingortoconfirmthatthesystemisoperatingasexpected.

Control4DeviceListThelasttwosectionsdisplaytheconfiguredControl4devices.Thefirstsectionshowsthedevicescurrentlyactiveintheconfiguration.ThesedeviceswillbeavailableinHomeKit.Thesecondsectionshowsdevicesthatarecurrentlybeingignored.Thesedevicesareknowntotheappliance,butwillnotbeavailableviaHomeKit.Youmaychoosetoignoredevicesthatareintentionallyhiddeninyourhome(virtualswitchesorunusedsecuritypartitions,forexample).

Page 9: Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

QuickStart

9

Figure4–TheControl4DeviceList

Foreachimporteddevice,youcanchoosethenameyouwouldlikeitdisplayedasinHomeKit.Everydevicenamemustbeunique.Ifyouattempttoconfiguredeviceswithduplicatenames,theappliancewillautomaticallymakethemuniqueforyou.YoucanchangethesenameslaterintheAppleHomeapp,withoutneedingtoupdatetheminHomebridge.Chooseyournamescarefully.ThesenameswillbehowSiriwillidentifyeachofyourdevices.Namesthataretoogenericortoouniquemayconfuseher.

Someidentifieddeviceswillonlyreferenceasinglephysicaldevice,suchasmotionsensors,garagedoors,orsecuritypanels.Otherdevicesmayrepresentseveraldifferentdevicetypes,suchasaControl4switch,whichmaybeconnectedtoalight,adimmer,afan,orafanspeedcontroller.TheappliancewilldoitsbesttoautomaticallyidentifythetypeofdeviceyouhaveimportedbasedonthenameofthedeviceintheControl4project.Youmayneedtomakecorrections.

Control4contactsensorsareinitiallyidentifiedasa“contactsensor”inHomeKit.InHomeKit,contactsensorswillshowthecurrentstate,butwillnotreportchangesvianotifications.Ifyouwanttobenotifiedwhendoorsorwindowsareopen/closed,changethedevicetypetoDoororWindow,respectively,andthenconfiguretheappropriatenotificationsinHomeKit.

Inadditiontothedevicetypeandname,youcanconfigurethefollowingvalues:

• Manufacturer–Themanufactureronthedevice.Fordisplaypurposesonly.• Model–Themodelofthedevice.Fordisplaypurposesonly.• IgnoreDevice–Anycheckeddevicesintheactivedeviceslistwillbemovedtothe

ignoreddevicelistwhentheconfigurationissaved.

Page 10: Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

QuickStart

10

ThelastsectionistheIgnoredDeviceslist.

Figure5–IgnoredDevices

Deviceslistedherearenoteditable,butcheckinganyofthemwillrestorethemtotheactivedevicelistwhentheconfigurationissaved.

Page 11: Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

QuickStart

11

AdvancedConfigurationCheckingtheEnableAdvancedConfigurationOptionscheckboxwilldisplayadditional,moreadvanced,configurationoptions.Theappliancecomespre-configuredwithseveralhelpfulhomebridgeplugins.Inthepluginlist,eachinstalledpluginwillbedisplayed,andifanewerversionhasbeenmadeavailablebyitsdeveloper,youwillbegiventheoptiontoupdate.

Figure6–AdvancedConfiguration

Theextrapluginscannotbedirectlyconfiguredbythewebconsole,butadvanceduserscanusetheoptiontoEditRawHomebridgeConfigFiletocreatetheproperconfigurationentriestoutilizetheseplugins/devices.

Inadditiontoeditingtherawhomebridgeconfiguration,youmayalsoClearPersistentHomebridgeData.ThiswillcausetheappliancetoforgetitsconnectiontoHomeKitandwillrequirethatyoure-configureyourHomeKitconfiguration.Thisisnotnormallynecessary,butmaysolvesomespecificissuesencounteredmostoftenduringinitialsetup.Dothisatyourownrisk.

Finally,youmayalsochangetheHomeKitUserName.Thisisalsonotusuallynecessary,butmayresolvesomeconnectionissuesduringinitialHomeKitpairing.Dothisatyourownrisk.

Page 12: Control4/HomeKit Appliance User Manual - Varietas …varietassoftware.com/control4/User-Guide.pdf · Control4/HomeKit Appliance User Manual 4 Introduction 1.1 Scope and Purpose The

QuickStart

12

AddingTheApplianceToHomeKitAfteryouhaveimportedyourControl4configuration,verifiedthatthedevicesaresetupcorrectly,andrestartedhomebridge,youarenowreadytoaddtheappliancetoHomeKit.OpenHomeKitonyourdevice,andtaptheAddAccessorybutton(ifyoudonothaveanyaccessoriesyet)orthe+buttonintheupperrightcorner(ifyoualreadyhavedevicesinHomeKit).TheHomebridgeappliance(s)shouldbedisplayedasanavailableaccessorytoadd.Dependingonthenumberofdevicesinyourconfiguration,youmayhaveoneormultiplehomebridgedevicesavailable.Selecteachoftheavailabledevices,inturn,andthenmanuallyentertheHomeKitPIN,asitisdisplayedintheappliancewebpage.

AdditionaldetailsonaddingaccessoriestoHomeKitandconfiguringdevicesinHomeKitcanbefoundhere(https://support.apple.com/en-us/HT204893).

SupportForquestionsorsupport,[email protected]