doudz / homeassistant-myjdownloader

myjdownloader integration for home assistant

MyJDownloader Integration for Home Assistant

This is still beta! Feedback, bug reports and contributions welcome!

Configuration

Add this repository to HACS, install this integration and restart Home Assistant. Adding MyJDownloader to your Home Assistant instance can be done via the user interface, by using this My button:

Manual configuration steps

• Browse to your Home Assistant instance.
• In the sidebar click on Configuration.
• From the configuration menu select: Integrations.
• In the bottom right, click on the Add Integration button.
• From the list, search and select "MyJDownloader".
• Follow the instruction on screen to complete the set up.

Note: Do not disable the sensor.jdownloaders_online entity, as it is responsible for checking for new JDownloaders which become online.

Features

Sensor

• status
• number of links
• number of packages

Note: number of links/packages sensors contain state attributes that have information on ETA while downloading.

Update

• update to latest version

Switch

• pause downloads
• limit download speed

Service

• myjdownloader.run_update_check
• myjdownloader.restart_and_update
• myjdownloader.start_downloads
• myjdownloader.stop_downloads
• myjdownloader.add_links

Note: Only select a single entity (e.g., the *_status entity) from the JDownloader when calling a service, not the JDownloader device.

Known Issues

• When using the pause switch, it might take a while for the status sensor to reflect the new pause state.
• There is not much error handling yet, e.g. when you change your password, you need to remove and add the integration again.
• Selecting a JDownloader device for a service target will call that service as many times as there are enabled entities for that device. This integration probably needs to be refactored in a way, that this is avoided e.g., with a designated myjdownloader.* entity.

homeassistant-myjdownloader's Issues

Poor configuration documentation - setup does not work

I set up sensor according to https://github.com/doudz/homeassistant-myjdownloader#configuration.

Restarted HA several times.

What is supposed to happen?

There´s no new integration when trying to manually add a new one.

There´s no new sensor.

Nothing.

Only log entry is

2020-12-07 21:40:50 WARNING (MainThread) [homeassistant.loader] You are using a custom integration for myjdownloader which has not been tested by Home Assistant. This component might cause stability problems, be sure to disable it if you experience issues with Home Assistant.

Is it a bug or do I just don´t get how to set this thing up?

[Feature request] Add credit of the 9kw Captcha Solver

It would be great if the extionsion could get the credit of the 9kw Captcha Solver.
In the screenshot it's the 177.

Idea: Send a messeage to smartphone when the credit is below 150.

auto - message all downloads done

Is it possible to make an automation with the sensor to announce when all downloads are done ? what will be the parameters for the sensor to indicate that
Thank you!

Deprecated entry_type in class MyJDownloaderDeviceEntity

I get the following log entry when I use your custom component.

Logger: homeassistant.helpers.frame
Source: helpers/frame.py:74
First occurred: 09:32:34 (8 occurrences)
Last logged: 09:32:35

Detected code that uses str for device registry entry_type. This is deprecated and will stop working in Home Assistant 2022.3, it should be updated to use DeviceEntryType instead. Please report this issue.

Could you please update this? You have to change entry_type="service" to entry_type = DeviceEntryType.SERVICE. You could do it like HACS does and check for the Home Assistant version.

# LEGACY can be removed when min HA version is 2021.12
if self.hacs.core.ha_version >= "2021.12.0b0":
    # pylint: disable=import-outside-toplevel
    from homeassistant.helpers.device_registry import DeviceEntryType

    info["entry_type"] = DeviceEntryType.SERVICE
else:
    info["entry_type"] = "service"
return info

Device not found

Hello just installed and tried to configure it

 - platform: myjdownloader
    email: [email protected]
    password: mypassword
    name: JDownloader@ubuntu-server
    scan_interval: 5

But i got error device not found

cannot install the integration

Hi,

when trying to install from repo link to HA I get an error message:

"Manual" installation of integration is also not possible, as the integration does not appear on the list of available ones..

Is this an issue just on my side, please?

thx, JJ

Rewrite with config flow

Forked thread from #6 to discuss rewrite of this integration with config flow and more platforms in https://github.com/oribafi/homeassistant-myjdownloader/tree/rewrite.

It's still in early development, so I'm grateful for feedback and anyone willing to test. Thanks for this great integration, which motivated me to learn how to write integrations for HA!

Features

Sensor

• status
• number of links
• number of packages

Binary Sensor

• update available

Switch

• pause downloads
• limit download speed

Service

• myjdwonloader.run_update_check
• myjdwonloader.restart_and_update
• myjdwonloader.start_downloads
• myjdwonloader.stop_downloads

Todo

• When using the pause switch, it might take a while for the status sensor to reflect the new pause state.
  I need to trigger the update of the status entity out-of-order, when the pause switch is toggled.
• There is not much error handling yet, e.g. when you change your password, you need to remove and add the integration again.
• Not tested with more than one JDownloader yet.
• Devices which are not online during setup of the integration should be created when they become available.
• Devices becoming offline will turn to unavilable.

Add device_id to the list of online devices

Hi,

I would like to suggest adding the device id to the list of online devices.
I achieved this by modifying the following part of sensor.py:

homeassistant-myjdownloader/custom_components/myjdownloader/sensor.py

Line 209 in 73168ac

def extra_state_attributes(self):

to:

    @property
    def extra_state_attributes(self):
        """Return the state attributes."""
        devices = sorted(self.devices.values(), key=lambda x: x.name)
        return {
            "jdownloaders": [device.name for device in devices],
            "jdownloader_ids": [device.device_id for device in devices],
        }

This allows people to create links directly to their current jdownloader instance.
for example in my single device use case:

  - type: custom:button-card
    tap_action:
      action: url
      url_path: >
        [[[
          return 'https://my.jdownloader.org/?deviceId='+states['sensor.jdownloaders_online'].attributes.jdownloader_ids[0]+'#webinterface:downloads';
        ]]]
    name: JDownloader
    ...

myjdapi version in requirements

The minimum required myjdapi version is 1.1.0 for the new integration. (Not a big thing at all, as we have no tests yet, I think)

homeassistant-myjdownloader/requirements.txt

Line 2 in dc63b17

myjdapi==1.0.6

Add Integration fails

Hi,

I attempt to Add Integration via the button on the GitHub readme, and I get this error: Config flow could not be loaded: Unknown error.

Any ideas?

Some sensors result unavailable

Some sensors, i.e. (packeges, links and update) results unavailable, I've tried both reconfiguring the integration from 0 and restarting supervisor, but to no avail. Are there any other procedures to try?

Limit option

Hi, could you please add the ability to write the LIMIT Bandwith parameter?
I would like to create an automation based on my presence at home (if i'm away, i could set no limit, if i'm home, i could set it to a minimium value...)

Thanks

cannot connect

I run the latest Home Assistant OS in a VM

When i try to setup the integration it alwys says cannot connect

Feature request: add service to allow adding new downloads

I would love to be able to add new downloads to the queue using a text input entity in home assistant through a service call.

Update to 46573 is still proposing into my home assistant but can't update

Hello dear developers,

Since 2 days my home assistant is proposing me the update like following

I click on it and have

Sadly if I want to update it I have this next screen:

The message says that it's not available.

Then if I close the window it come back again.

I tried to remove the integration from here:

And re added but it seems that the update message is coming back anyway.

I do believe it's the second time it's happening with Myjdownloader updates to be kind of stucked on my config

I use a Odroid home assistant blue
With this configuration:

(not sure what to show more to help on this topic. Let me know if you need more intel)

Unable to Integrate in Home Assistant Integration Flow

Hello!

I'm unable to find the custom integration in the add integrations page of Home Assistant. Any assistance on this?

Feature request: ETA

Would be nice to have a entity that shows the ETA time of the download.

Add a license

I just noticed, you haven't chosen a license for your integration. Would you mind doing so?

Device not found

Hy, thank you for your effort. I configured your integration but the sensor state is device not found. I use regularly myjdownloader extension on chrome.
Thank you for your reply.

Access from local - Docker JDownloader

Would it be possible to access the data, for the sensors, switches, etc., using a device: ip:port, instead of an account from the cloud?
It could possibly resolve the lag-time-reaction.

2024.1.0 deprication Warning DATA_RATE_MEGABYTES_PER_SECOND

This should be fixed:

DATA_RATE_MEGABYTES_PER_SECOND was used from myjdownloader, this is a deprecated constant which will be removed in HA Core 2025.1. Use UnitOfDataRate.MEGABYTES_PER_SECOND instead, please create a bug report at https://github.com/doudz/homeassistant-myjdownloader/issues

Request: more Metadata

Hi,
thanks for the integration 👍

It would be great to make some more information available.
Possible candidates would be
device.downloadcontroller.get_speed_in_bytes()
and
device.downloads.query_links()

What do you think?

The 'links' sensor is not present

What is the reason that I can't display the list of links in the tab?

Device not found

Hey doudz,
thanks for your myjdownloader integration.
Maybe i'm doing something wrong. It detects my instance but it says "Device not found"

sensor:
  - platform: myjdownloader
    email: !secret mail
    password: !secret pwd2

Error after changing scan_interval

Hi,

I set this component up into HA. After reboot it was in developer panel but with no download shown.

So i changed added the sensor to add the optionnal scan_interval with value = 2

`

• platform: myjdownloader
  email: [email protected]
  password: mypassword
  scan_interval: 2
  `

Then, after reboot, I got an error shown below. Any idea of what is wrong?

myjdownloader: Error on device update! Traceback (most recent call last): File "/usr/src/homeassistant/homeassistant/helpers/entity_platform.py", line 292, in _async_add_entity await entity.async_device_update(warning=False) File "/usr/src/homeassistant/homeassistant/helpers/entity.py", line 461, in async_device_update await self.hass.async_add_executor_job(self.update) File "/usr/local/lib/python3.7/concurrent/futures/thread.py", line 57, in run result = self.fn(*self.args, **self.kwargs) File "/config/custom_components/myjdownloader/sensor.py", line 110, in update currentDownloads = [x for x in downloadList if not x['finished']] File "/config/custom_components/myjdownloader/sensor.py", line 110, in <listcomp> currentDownloads = [x for x in downloadList if not x['finished']] KeyError: 'finished'