SYS-HTTP Switch: Difference between revisions

sys-http
sys-http
General
Author	zaksabeast
Type	Sysmodules
Version	0.1.0
License	GPL-3.0
Last Updated	2020/05/31
Links
	Download
	Website
	Source

Revision as of 11:41, 24 April 2023

This is a sysmodule that allows communicating with the Nintendo Switch using http. This sysmodule brings a few advantages that don't currently exist:

HTTP is a standardized protocol with well defined uses.
Most languages have at least one http library, so there's not a need to write a wrapper around raw TCP.
Web browsers can use HTTP, but not raw TCP (without disabling security rules).

Installation

Download the zip from the latest releases.

Copy the zip file contents to your switch SD card at /atmosphere/contents.

It's recommended to use something like Kosmos Toolbox/Hekate Toolbox and disable the sysmodule when it's not in use.

User guide

Projects using sys-http:

https://github.com/zaksabeast/DenCrawler - View Pokemon Sword and Shield event raids in the web browser.

Potential future use cases:

Read Pokemon Sword/Shield den seeds directly into @Admiral-Fish's RaidFinder or @leanny's Seed Checker.
Display Animal Crossing turnip prices in a mobile app.
Show updating game values during a Twitch live stream.
Setup a PKHeX REST API and live edit Pokemon from a website.
Create a Discord bot that allows users to interact with the console.

Developing frontend applications: If you want to build frontend applications using this sysmodule as a backend, reading this documentation will help you.

Changelog

v0.1.0 2020/05/31

Added:
- CORS headers to allow web browsers to work with sys-http.
- /settings/language to get the console language.
Updated:
- /readHeap is now /heap.

v0.0.1 2020/05/26

Initial release.

Credits

Thanks to the following groups, individuals, and contributors:

ReSwitched for Atmosphere-libs.
Switchbrew for libnx.
yhirose for cpp-httplib.

External links

@@ Line 1: / Line 1: @@
 {{Infobox Switch Homebrews
 |title=sys-http
-|image=syshttpswitch.png
+|image=syshttpnx.png
 |description=Build tools that communicate with the Switch over http.
 |author=zaksabeast
 |lastupdated=2020/05/31
-|type=System Tools
+|type=Sysmodules
 |version=0.1.0
 |license=GPL-3.0
-|download=https://dlhb.gamebrew.org/switchhomebrews/syshttpswitch.7z
+|download=https://dlhb.gamebrew.org/switchhomebrews/syshttpnx.7z
 |website=https://gbatemp.net/threads/sys-http-build-tools-that-communicate-with-the-switch-over-http.565986/
 |source=https://github.com/zaksabeast/sys-http
 |donation=
 }}
-{{#seo:
+This is a sysmodule that allows communicating with the Nintendo Switch using http. This sysmodule brings a few advantages that don't currently exist:
-|title=Switch Homebrew Apps (System Tools) - GameBrew
+*HTTP is a standardized protocol with well defined uses.
-|title_mode=append
+*Most languages have at least one http library, so there's not a need to write a wrapper around raw TCP.
-|image=syshttpswitch.png
+*Web browsers can use HTTP, but not raw TCP (without disabling security rules).
-|image_alt=sys-http
-}}
+==Installation==
-{{cleanup|article|Needs cleanup}}
+Download the zip from the latest releases.
-Build tools that communicate with the Switch over http.
+Copy the zip file contents to your switch SD card at /atmosphere/contents.
+It's recommended to use something like [[Hekate_Toolbox_Switch|Kosmos Toolbox/Hekate Toolbox]] and disable the sysmodule when it's not in use.
-==Media==
+==User guide==
-<youtube></youtube>
+Projects using sys-http:
+*https://github.com/zaksabeast/DenCrawler - View Pokemon Sword and Shield event raids in the web browser.
+Potential future use cases:
+*Read Pokemon Sword/Shield den seeds directly into @Admiral-Fish's [https://github.com/Admiral-Fish/RaidFinder RaidFinder] or @leanny's [http://leanny.github.io/seedchecker Seed Checker].
+*Display Animal Crossing turnip prices in a mobile app.
+*Show updating game values during a Twitch live stream.
+*Setup a [https://github.com/zaksabeast/PKHeX-Lambda PKHeX REST API] and live edit Pokemon from a website.
+*Create a Discord bot that allows users to interact with the console.
-==Screenshots==
+Developing frontend applications:
-https://dlhb.gamebrew.org/switchhomebrews/syshttpswitch-01.png
+If you want to build frontend applications using this sysmodule as a backend, [https://github.com/zaksabeast/sys-http#developing-frontend-applications reading this documentation] will help you.
-https://dlhb.gamebrew.org/switchhomebrews/syshttpswitch-02.png
-https://dlhb.gamebrew.org/switchhomebrews/syshttpswitch-03.png
-https://dlhb.gamebrew.org/switchhomebrews/syshttpswitch-04.png
-https://dlhb.gamebrew.org/switchhomebrews/syshttpswitch-05.png
-https://dlhb.gamebrew.org/switchhomebrews/syshttpswitch-06.png
-https://dlhb.gamebrew.org/switchhomebrews/syshttpswitch-07.png
-https://dlhb.gamebrew.org/switchhomebrews/syshttpswitch-08.png
 ==Changelog==
-'''v.1.0'''
+'''v0.1.0 2020/05/31'''
-* First Release.
+*Added:
+**CORS headers to allow web browsers to work with sys-http.
+**/settings/language to get the console language.
+*Updated:
+**/readHeap is now /heap.
+'''v0.0.1 2020/05/26'''
+*Initial release.
+==Credits==
+Thanks to the following groups, individuals, and contributors:
+*ReSwitched for [https://github.com/Atmosphere-NX/Atmosphere-libs Atmosphere-libs].
+*Switchbrew for [https://github.com/switchbrew/libnx libnx].
+*yhirose for [https://github.com/yhirose/cpp-httplib/ cpp-httplib].
 == External links ==
-* Gbatemp - https://gbatemp.net/threads/sys-http-build-tools-that-communicate-with-the-switch-over-http.565986/
+* GitHub - https://github.com/zaksabeast/sys-http
-* Github - https://github.com/zaksabeast/sys-http
+* GBAtemp - https://gbatemp.net/threads/sys-http-build-tools-that-communicate-with-the-switch-over-http.565986/
-* Reddit -