Metadata-Version: 2.1
Name: pyps4-2ndscreen
Version: 1.3.1
Summary: PS4 2nd Screen Python Library
Home-page: https://github.com/ktnrg45/pyps4-2ndscreen
Author: ktnrg45
Author-email: ktnrg45dev@gmail.com
License: LGPLv2+
Keywords: playstation sony ps4 2nd screen 2ndscreen
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Environment :: Console :: Curses
Classifier: Framework :: AsyncIO
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Home Automation
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Hardware
Requires-Python: >=3.6.0
Description-Content-Type: text/markdown
Requires-Dist: aiohttp (>=3.5.4)
Requires-Dist: click (>=7.0)
Requires-Dist: construct (>=2.9.45)
Requires-Dist: pycryptodomex (>=3.7.2)
Requires-Dist: windows-curses (>=2.1.0) ; platform_system == "Windows"

PyPS4-2ndScreen
==========================================

|BuildStatus| |PypiVersion| |PyPiPythonVersions| |CodeCov|

|Docs|

Description
--------------------
A full Python implementation based on the Node.js package, ps4-waker, which is an unofficial API for the PS4 2nd Screen App.

This module is mainly targeted towards developers although the module does include a basic CLI.


**Disclaimer**:
This project/module and I are not affiliated with or endorsed by Sony Interactive Entertainment LLC. As such this project may break at any time.

Features
---------
This module can perform almost every feature found in the PS4 Second Screen App.

- PS4 power and playing media state/status reporting
- Remote control
- Power on and standby control
- Starting a specific game/media
- Media information retrieval from the Playstation Store

Compatibility
--------------------
Tested on:

- Environment: Python 3.6/3.7/3.8

- Operating System: Debian


Installation
--------------------
Package can be installed with pip or from source.

It is advised to install the module in a virtual env.

Create virtual env first:

.. code:: bash

    python -m venv .
    source bin/activate

To install from pip:

.. code:: bash

    pip install pyps4-2ndscreen

To install from source clone this repository and run from top-level:

.. code:: bash

    pip install -r requirements.txt
    python setup.py install

Protocol
--------------------
UDP is used to get status updates and retrieve user credentials. TCP is used to send commands to the PS4 Console.

Ports
--------------------
This module uses UDP port 1987 by default as the source port for polling the PS4.

PS4 listens on ports 987 (Priveleged) to fetch user PSN credentials.

In order to obtain user credentials, the Python Interpreter needs access to port 987 on the host system.
The credential service pretends to be a PS4 console and will receive broadcast packets from the PS4 2nd Screen app on port 987.

Example:

.. code:: bash

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

This is so you do not need sudo/root priveleges to run.


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.

Known Issues
--------------------
- PS Command inconsistent.
- On-Screen Keyboard is not implemented.


Credits
--------------------
Thanks to hthiery for writing the underlying socket protocol in Python. https://github.com/hthiery/python-ps4

References
--------------------

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


.. |BuildStatus| image:: https://circleci.com/gh/ktnrg45/pyps4-2ndscreen.svg?style=svg
                 :target: https://circleci.com/gh/ktnrg45/pyps4-2ndscreen
.. |PyPiVersion| image:: https://badge.fury.io/py/pyps4-2ndscreen.svg
                 :target: http://badge.fury.io/py/pyps4-2ndscreen
.. |PyPiPythonVersions| image:: https://img.shields.io/pypi/pyversions/pyps4-2ndscreen.svg
                        :alt: Python versions
                        :target: http://badge.fury.io/py/pyps4-2ndscreen
.. |Docs| image:: https://readthedocs.org/projects/pyps4-2ndscreen/badge/?version=dev
          :target: https://pyps4-2ndscreen.readthedocs.io/en/dev/?badge=dev
          :alt: Documentation Status
.. |CodeCov| image:: https://codecov.io/gh/ktnrg45/pyps4-2ndscreen/branch/dev/graph/badge.svg               
             :target: https://codecov.io/gh/ktnrg45/pyps4-2ndscreen/
             :alt: Code Coverage