help.py

   1 # The MIT License (MIT)
   2 #
   3 # Copyright (c) Sharil Tumin
   4 #
   5 # Permission is hereby granted, free of charge, to any person obtaining a copy
   6 # of this software and associated documentation files (the "Software"), to deal
   7 # in the Software without restriction, including without limitation the rights
   8 # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   9 # copies of the Software, and to permit persons to whom the Software is
  10 # furnished to do so, subject to the following conditions:
  11 #
  12 # The above copyright notice and this permission notice shall be included in
  13 # all copies or substantial portions of the Software.
  14 #
  15 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16 # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17 # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18 # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19 # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  21 # THE SOFTWARE.
  22 #
  23
  24 Setting = {
  25     'pixformat':0,  # 0:JPEG, 1:Grayscale (2bytes/pixel), 2:RGB565
  26     'framesize':11, # 1:96x96, 2:160x120, 3:176x144, 4:240x176, 5:240x240
  27                     # 6:320x240, 7:400x296, 8:480x320, 9:640x480, 10:800x600
  28                     # 11:1024x768, 12:1280x720, 13:1280x1024, 14:1600x1200
  29                     # 15:1920x1080, 16:720x1280, 17:864x1536, 18:2048x1536
  30
  31     'quality':11,   # [0,63] lower number means higher quality
  32     'contrast':0,   # [-2,2] higher number higher contrast
  33     'saturation':0, # [-2,2] higher number higher saturation. -2 grayscale
  34     'brightness':0, # [-2,2] higher number higher brightness. 2 brightest
  35     'speffect':0,   # 0:,no effect 1:negative, 2:black and white, 3:reddish,
  36                     # 4:greenish, 5:blue, 6:retro
  37
  38     'whitebalance':0, # 0:default, 1:sunny, 2:cloudy, 3:office, 4:home
  39     'aelevels':0,     # [-2,2] AE Level: Automatic exposure
  40     'aecvalue':0,     # [0,1200] AEC Value: Automatic exposure control
  41     'agcgain':0,      # [0,30] AGC Gain: Automatic Gain Control
  42 }
  43
  44 def help(server):
  45     c=Setting
  46     return f"""
  47 Autentication:
  48   Login to server with a one-time password.
  49   http://{server}/login/<PWD>
  50   After login, only the authenticated client can connect to server.
  51
  52   Logout from server.
  53   http://{server}/logout
  54   The client is no longer authenticated. Create new one-time password.
  55   The password is shown in REPL.
  56   Any web browser can now login using the password.
  57
  58   NB! The server is open to all if auth.on=False
  59
  60 Help:
  61   Show this page
  62   http://{server}
  63   If auth.on=True then you need to login first.
  64
  65 Streaming:
  66   Webcam live streaming
  67   http://{server}/webcam
  68   To stop streaming just go to other URL e.g. http://{server}/snap
  69
  70 Still photo:
  71   Take picture
  72   http://{server}/snap
  73
  74   Take picture with LED flash
  75   http://{server}/blitz
  76
  77 HTML image view port rotation:
  78   Rotate the <img> with transform:rotate() in style defination.
  79   http://{server}/rot/n
  80   n is one these value [0,90,180,270,360]. You can display the
  81   image/video taken by the camera in portrait or landscape mode by
  82   rotating the image view port. Depending on your camera sensor and
  83   the orientation of your board, http://{server}/rot/90 may show
  84   portrait mode image on your browser.
  85
  86 Camera setting:
  87   pixformat - http://{server}/fmt/n
  88   framesize - http://{server}/pix/n
  89   quality - http://{server}/qua/n
  90   contrast - http://{server}/con/n
  91   saturation - http://{server}/sat/n
  92   brightness - http://{server}/bri/n
  93   speffect - http://{server}/spe/n
  94   whitebalance - http://{server}/wbl/n
  95   aelevels - http://{server}/ael/n
  96   aecvalue - http://{server}/aec/n
  97   agcgain - http://{server}/agc/n
  98
  99   NB! n is integer value (can be negative).
 100       See listing below for appropriate value for each setting.
 101
 102 Camera current setting:
 103   pixformat={c['pixformat']}    # 0:JPEG, 1:Grayscale (2bytes/pixel), 2:RGB565
 104   framesize={c['framesize']}   # 1:96x96, 2:160x120, 3:176x144, 4:240x176, 5:240x240
 105                  # 6:320x240, 7:400x296, 8:480x320, 9:640x480, 10:800x600
 106                  # 11:1024x768, 12:1280x720, 13:1280x1024, 14:1600x1200
 107                  # 15:1920x1080, 16:720x1280, 17:864x1536, 18:2048x1536
 108   quality={c['quality']}     # [10,63] lower number means higher quality
 109   contrast={c['contrast']}     # [-2,2] higher number higher contrast
 110   saturation={c['saturation']}   # [-2,2] higher number higher saturation. -2 grayscale
 111   brightness={c['brightness']}   # [-2,2] higher number higher brightness. 2 brightest
 112   speffect={c['speffect']}     # 0:,no effect 1:negative, 2:black and white, 3:reddish,
 113                  # 4:greenish, 5:blue, 6:retro
 114   whitebalance={c['whitebalance']} # 0:default, 1:sunny, 2:cloudy, 3:office, 4:home
 115   aelevels={c['aelevels']}     # [-2,2] AE Level: Automatic exposure
 116   aecvalue={c['aecvalue']}     # [0,1200] AEC Value: Automatic exposure control
 117   agcgain={c['agcgain']}      # [0,30] AGC Gain: Automatic Gain Control
 118
 119 """