simplefancontroller.api.routers package¶

Submodules¶

simplefancontroller.api.routers.auth module¶

async simplefancontroller.api.routers.auth.create_user(user: User = Body(Ellipsis))¶: Creates a new SFC User.

async simplefancontroller.api.routers.auth.delete_user(email: str)¶: Delete a SFC User.

async simplefancontroller.api.routers.auth.get_user(email: str)¶: Get a single SFC User by email.

async simplefancontroller.api.routers.auth.get_users()¶: Get a list of all stored SFC Users

async simplefancontroller.api.routers.auth.user_change_password(user: UserPassUpdateSchema, request: Request)¶: Change a SFC User’s password

async simplefancontroller.api.routers.auth.user_login(user: UserLoginSchema = Body(Ellipsis))¶: Login a SFC User.

simplefancontroller.api.routers.auth.user_login_check(user: UserPassUpdateSchema, request: Request)¶

simplefancontroller.api.routers.controller module¶

simplefancontroller.api.routers.controller.get_temperature()¶: Get current CPU temperature.

simplefancontroller.api.routers.controller.initialize_controller()¶: Import data on FastAPI app start.

simplefancontroller.api.routers.controller.shutdown_controller()¶: Shutdown the controller on exit.

simplefancontroller.api.routers.fans module¶

async simplefancontroller.api.routers.fans.add_fan(fan: SFCFanSettings)¶: Add a new SFCFan.

async simplefancontroller.api.routers.fans.get_fan(id: str) → SFCFanSettings¶: Get a single SFCFan by its id.

async simplefancontroller.api.routers.fans.get_fans()¶: Get a list of all stored SFCFans.

async simplefancontroller.api.routers.fans.get_status_all()¶: Get the status of all stored SFCFans.

async simplefancontroller.api.routers.fans.get_status_single(id: str)¶: Get the status of a single SFCFan.

async simplefancontroller.api.routers.fans.remove_fan(id: str)¶: Delete a SFCFan.

async simplefancontroller.api.routers.fans.update_fan(id: str, fan: SFCFanSettings)¶: Update a SFCFan with new settings.

simplefancontroller.api.routers.settings module¶

async simplefancontroller.api.routers.settings.add_persistence(settings: SFCDBSettings)¶: Adds settings for a database client.

async simplefancontroller.api.routers.settings.delete_persistence_settings(id: str)¶: Update the current persistence settings.

async simplefancontroller.api.routers.settings.get_persistence_settings()¶: Get the current persistence settings.

async simplefancontroller.api.routers.settings.get_settings()¶: Get the current SFController settings.

async simplefancontroller.api.routers.settings.update_persistence(name: str, settings: SFCDBSettings)¶: Updates the settings for a database client.

async simplefancontroller.api.routers.settings.update_settings(settings: SFControllerSettings)¶: Update the SFController settings.

Module contents¶