Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add ResetToMenu to docs #32

Merged
merged 1 commit into from
Oct 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -306,7 +306,7 @@ service.

Currently defined capabilities are:
```grpc
// capabilities of a SNES device
// capabilities of a device
enum DeviceCapability {
None = 0;
ReadMemory = 1;
@@ -315,6 +315,18 @@ enum DeviceCapability {
ResetSystem = 4;
PauseUnpauseEmulation = 5;
PauseToggleEmulation = 6;
ResetToMenu = 7;
FetchFields = 8;
ReadDirectory = 10;
MakeDirectory = 11;
RemoveFile = 12;
RenameFile = 13;
PutFile = 14;
GetFile = 15;
BootFile = 16;
NWACommand = 20;
}
```

@@ -327,6 +339,9 @@ The `WriteMemory` capability grants usage of the the `DeviceMemory` service's
The `ResetSystem` capability grants usage of the `DeviceControl` service's
`ResetSystem` method.

The `ResetToMenu` capability grants usage of the `DeviceControl` service's
`ResetToMenu` method.

The `PauseUnpauseEmulation` capability grants usage of the
`DeviceControl.PauseUnpauseEmulation` method.

@@ -543,6 +558,9 @@ executing the request and in the same order received.
On devices that support it, this method resets the system the same way pressing
the RESET button/slider on the SNES hardware console does.

#### [ResetToMenu](https://github.com/alttpo/sni/blob/main/protos/sni/sni.proto#L21)
On devices that support it (currently only FXPakPro), this method resets the system to the menu.

#### [PauseUnpauseEmulation](https://github.com/alttpo/sni/blob/main/protos/sni/sni.proto#L83)
On devices that support it, this method allows the application to explicitly
control the paused/running state of emulation. This is generally not supported