How to add HomeKit accessory using HMAccessoryPayLoad?

Question

Hello currently I'm working on HomeKit, I want achieve one feature using HomeKit.

My requirement is without using QR code I want to add accessory. As every accessory has it's own URL like e.g. X-HM://XXXXXXXXX associated with QR code, i.e. HMAccessoryPayLoad.

The very similar questions which are unanswered I can see

How to Add and Set up accessory using HMAccessoryPayLoad

Open HomeKits X-HM:// URL sheme

So as per documentation I tried using below code to add accessory. I hope using this code we can add accessory directly without opening default HomeKit camera view.

if #available(iOS 11.3, *) {

    let payload = HMAccessorySetupPayload.init(url: URL.init(string: "X-HM://XXXXXXXXXX")!)

    home!.addAndSetupAccessories(with: payload!) { (accessories, error) in

        if let error = error {
            print("Error from addAndSetupAccessories:",error)
        } else {
            print("The accessory is added.")
        }
    }
} else {
    // Fallback on earlier versions
}

After running this code it's not giving either error or success. I tried checking console but it is empty.

Can you please help me to add accessory using payload & without using code or opening default camera view.

Have you ever found how to use this method? same problem for me, the callback is never called — axl coder, Sep 17 '20 at 14:41
till not i didn't got anything to it :( i'll post if i'll get it. — Shrikant K, Oct 02 '20 at 10:58

axl coder · Answer 1 · 2020-10-02T14:44:13.017

I had the answer from Apple Support, because basically I was in the same situation.

Basically this API doesn't work if you don't add the Entitlement "com.apple.developer.homekit.allow-setup-payload" with value equals to True.

I know, there is no documentation regarding this, but this is it.

Moreover, the point is that I don't know at the moment how to add this entitlement to the provisioning profile. I have asked to Apple support, and I will update this thread Xamarin iOS - HomeKit integration as soon as I have the answer.

You can see that this is the right approach because if you try it on the simulator it will work. The point is that to use it on a real device we need the entitlement in the provisioning profile.

score 0 · Answer 2 · answered Aug 11 '21 at 10:24

Not sure this is still relevant to anybody, but in order to have this fixed you have to add this capability to your provisioning profile on your apple developer account -> Certificates, Identifier and Profiles -> choose your identifier -> go to the Additional Capabilities tab and you will find there the HomeKit AllowSetupPayload.

I am not sure why this is not included within the normal HomeKit but that's what fixed it for me.

score 0 · Answer 3 · answered Sep 13 '22 at 07:35

0

I got a help email from Apple, how to enable com.apple.developer.homekit.allow-setup-payload, the entitlement itself is managed by the MFI team, so you'd need to reach out to your MFI representative to request the entitlement.

answered Sep 13 '22 at 07:35

jianhai

1
1

As it’s currently written, your answer is unclear. Please [edit] to add additional details that will help others understand how this addresses the question asked. You can find more information on how to write good answers [in the help center](/help/how-to-answer). – Vikram Parimi Sep 17 '22 at 18:31

How to add HomeKit accessory using HMAccessoryPayLoad?

3 Answers3

Linked