Skip to main content

PS4 Python Library for Home Assistant

Project description

Python Control for PlayStation 4 consoles.
============================

|BuildStatus| |PypiVersion| |PyPiPythonVersions|

Purpose
----------
To add a pure python implementation of ps4-waker. Including PS4 credential creation.
Integration with Home-Assistant.

Compatibility
----------
Tested on:
Python 3.5/3.6/3.7
Home-Assistant/Hass.IO 0.89


**This package can be used as a standalone api. It does not require the use of Home Assistant.

Installation
----------
run "pip install pyps4-homeassistant"

Ports
----------
PS4 listens on ports 987 and 997 (Priveleged).
Must run command on python path if no access:

"sudo setcap 'cap_net_bind_service=+ep' /usr/bin/python3.5"

Usage
----------
API should be accessed initially like the following examples.

Most functions can be accessed from the high-level PS4 object.


import pyps4_homeassistant

pyps4_homeassistant.ps4.Ps4("192.168.0.2", "YourCredentials")


Credentials can be generated by running:

creds = pyps4_homeassistant.credential.Credentials()

credentials = creds.start()

This will start the credential service and will return the credentials for the PSN Account. You will need to get the PS4 Second Screen app for Android or iOS to do this. Once you have logged in with your acccount in the app and started the service, refresh the devices in the app and select the device name 'Home-Assistant'.



Cover Art Issues
----------
If you find that media art cannot be found. Please post an issue with your Region, Country, Title of game, an ID of game.

To Do List:
----------
- Port TCP and UDP functions to Asyncio.



References
----------

- https://github.com/dsokoloski/ps4-wake
- https://github.com/dhleong/ps4-waker
- https://github.com/hthiery/python-ps4

.. _ps4-waker: https://github.com/dhleong/ps4-waker

.. |BuildStatus| image:: https://travis-ci.org/ktnrg45/pyps4-homeassistant.png?branch=master
:target: https://travis-ci.org/ktnrg45/pyps4-homeassistant
.. |PyPiVersion| image:: https://badge.fury.io/py/pyps4-homeassistant.svg
:target: http://badge.fury.io/py/pyps4-homeassistant
.. |PyPiPythonVersions| image:: https://img.shields.io/pypi/pyversions/pyps4-homeassistant.svg
:alt: Python versions
:target: http://badge.fury.io/py/pyps4-homeassistant


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyps4_homeassistant-0.7.2.tar.gz (24.4 kB view hashes)

Uploaded Source

Built Distribution

pyps4_homeassistant-0.7.2-py3-none-any.whl (42.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page