feat: implements customizable alarm vibration

[theMr17]

Fixes #470

This adds a feature to enable or disable vibration of any individual alarm.

[yuriykulikov]

UI looks good, but there are a few things missing:

• What should be the behaviour of the Vibrate preference in settings?
• What should be the default value for this new checkbox?
• Are there any additional changes required in VibrationPlugin.kt?

[theMr17]

• What should be the behaviour of the Vibrate preference in settings?

According to me Vibrate preference in settings can be removed, as individual alarms will have there own vibrate preference now.

• What should be the default value for this new checkbox?

As of now, the default value for this new checkbox is set to true

• Are there any additional changes required in VibrationPlugin.kt?

I don't think any additional changes are required in VibrationPlugin.kt

[theMr17]

Hi @yuriykulikov, I have made the changes which you mentioned. Please have a look.

[yuriykulikov]

It seems to me that keeping the preference would be better. Probably in a different form.

What do you think about the following:

Create a new vibration preference with 3 possible values:

• Vibration is always off (this removes the chexkbox from alarm details)
• Vibration is on per default
• Vibration is off per default

Another possibility would be to treat the value in settings as the default for newly created alarms

[yuriykulikov]

@the-mr17 also please have a look at https://github.com/yuriykulikov/AlarmClock/blob/develop/app/src/main/java/com/better/alarm/background/VibrationPlugin.kt#L36

[theMr17]

Create a new vibration preference with 3 possible values:

• Vibration is always off (this removes the chexkbox from alarm details)
• Vibration is on per default
• Vibration is off per default

I am planning to implement this one.

[theMr17]

@yuriykulikov I have implemented the new vibration preference. Please have a look.

[yuriykulikov]

Looking good!

Here are some remaining points:

• VibrationPlugin changes required
• Translations
• Tests

[yuriykulikov]

Try testing this. From the code alone I assume that changing the value for an alarm will not have any effect on the vibration, because here you evaluate only the global setting. I think alarm: PluginAlarmData, should contain the data you need to decide per alarm.

[theMr17]

I have tested it on a physical device, it works well.

[yuriykulikov]

Ok, let's walk through the code.

Given
The preference value is "on"
And alarm checkbox is not checked

When
Alarm fires

Then
What is expected?
What actually happens?

[theMr17]

I am a bit confused over here. Can you please guide me, exactly what needs to be done here.

[yuriykulikov]

what needs to be done here

You have to walk through the code as if you are Android. You can try writing comments on each like. Repeat this process 6 times for this particular function with different input parameters:

• Setting on & alarm vibrate on
• Setting on & alarm vibrate off
• Setting off & alarm vibrate on
• Setting off & alarm vibrate off
• Setting alwaysOff & alarm vibrate on
• Setting alwaysOff & alarm vibrate off

[yuriykulikov]

Could you please add translations for German, Spanish, Italian, Norwegian, Russian and Ukranian? You can use ChatGPT for this, like this:

Please translate into German, Spanish, Italian, Norwegian, Russian and Ukranian:
<string name="vibration_title">Vibration</string>
<string-array name="vibration_entries">
        <item>On by default</item>
        <item>Off by default</item>
        <item>Disabled</item>
</string-array>

This also is not very intuitive, so probably we should carefully explain to the user what is the deal here.

[theMr17]

Could you please add translations for German, Spanish, Italian, Norwegian, Russian and Ukranian? You can use ChatGPT for this, like this:

Sure, I am adding the translations of those languages.

This also is not very intuitive, so probably we should carefully explain to the user what is the deal here.

Can you please say more on how can I do this?