From 491e160eb000a9a7d95cbbca8f9575c32dfdef86 Mon Sep 17 00:00:00 2001 From: HASUMI Hitoshi Date: Thu, 3 Oct 2024 19:01:53 +0900 Subject: [PATCH] update --- _data/sidebars/picoruby_sidebar.yml | 58 ++++++++++-- pages/rbs_doc/Base64.md | 10 +++ pages/rbs_doc/Editor_Base.md | 5 ++ pages/rbs_doc/GPIO_Error.md | 15 ++++ pages/rbs_doc/IO.md | 5 ++ pages/rbs_doc/IOError.md | 6 -- pages/rbs_doc/JSON_DiggerError.md | 9 ++ pages/rbs_doc/JSON_GeneratorError.md | 9 ++ pages/rbs_doc/JSON_JSONError.md | 9 ++ pages/rbs_doc/JSON_ParserError.md | 9 ++ pages/rbs_doc/JWT.md | 20 +++++ pages/rbs_doc/JWT_VerificationError.md | 9 ++ pages/rbs_doc/MbedTLS.md | 6 +- pages/rbs_doc/MbedTLS_HMAC.md | 41 +++++++++ pages/rbs_doc/PicoLine.md | 20 +++++ pages/rbs_doc/PicoLine_Question.md | 18 ++++ pages/rbs_doc/PicoRubyVM.md | 16 +++- .../rbs_doc/PicoRubyVM_InstructionSequence.md | 31 +++++++ pages/rbs_doc/RNG.md | 5 ++ pages/rbs_doc/Task.md | 90 ++++++++++++++++--- pages/rbs_doc/YAML.md | 20 +++++ 21 files changed, 386 insertions(+), 25 deletions(-) create mode 100644 pages/rbs_doc/GPIO_Error.md create mode 100644 pages/rbs_doc/JSON_DiggerError.md create mode 100644 pages/rbs_doc/JSON_GeneratorError.md create mode 100644 pages/rbs_doc/JSON_JSONError.md create mode 100644 pages/rbs_doc/JSON_ParserError.md create mode 100644 pages/rbs_doc/JWT.md create mode 100644 pages/rbs_doc/JWT_VerificationError.md create mode 100644 pages/rbs_doc/MbedTLS_HMAC.md create mode 100644 pages/rbs_doc/PicoLine.md create mode 100644 pages/rbs_doc/PicoLine_Question.md create mode 100644 pages/rbs_doc/PicoRubyVM_InstructionSequence.md create mode 100644 pages/rbs_doc/YAML.md diff --git a/_data/sidebars/picoruby_sidebar.yml b/_data/sidebars/picoruby_sidebar.yml index d57301e..1b020b3 100644 --- a/_data/sidebars/picoruby_sidebar.yml +++ b/_data/sidebars/picoruby_sidebar.yml @@ -97,6 +97,10 @@ entries: url: "/Exception.html" output: web pdf type: homepage + - title: class GPIO + url: "/GPIO.html" + output: web pdf + type: homepage - title: class IOError url: "/IOError.html" output: web pdf @@ -207,10 +211,6 @@ entries: url: "/ADC.html" output: web pdf type: homepage - - title: class GPIO - url: "/GPIO.html" - output: web pdf - type: homepage - title: class I2C url: "/I2C.html" output: web pdf @@ -338,6 +338,10 @@ entries: url: "/File_Stat.html" output: web pdf type: homepage + - title: class GPIO::Error + url: "/GPIO_Error.html" + output: web pdf + type: homepage - title: class IIRFilter url: "/IIRFilter.html" output: web pdf @@ -358,14 +362,38 @@ entries: url: "/JSON_Digger.html" output: web pdf type: homepage + - title: class JSON::DiggerError + url: "/JSON_DiggerError.html" + output: web pdf + type: homepage - title: class JSON::Generator url: "/JSON_Generator.html" output: web pdf type: homepage + - title: class JSON::GeneratorError + url: "/JSON_GeneratorError.html" + output: web pdf + type: homepage + - title: class JSON::JSONError + url: "/JSON_JSONError.html" + output: web pdf + type: homepage - title: class JSON::Parser url: "/JSON_Parser.html" output: web pdf type: homepage + - title: class JSON::ParserError + url: "/JSON_ParserError.html" + output: web pdf + type: homepage + - title: module JWT + url: "/JWT.html" + output: web pdf + type: homepage + - title: class JWT::VerificationError + url: "/JWT_VerificationError.html" + output: web pdf + type: homepage - title: class MML url: "/MML.html" output: web pdf @@ -374,7 +402,7 @@ entries: url: "/Machine.html" output: web pdf type: homepage - - title: class MbedTLS + - title: module MbedTLS url: "/MbedTLS.html" output: web pdf type: homepage @@ -390,6 +418,10 @@ entries: url: "/MbedTLS_Digest.html" output: web pdf type: homepage + - title: class MbedTLS::HMAC + url: "/MbedTLS_HMAC.html" + output: web pdf + type: homepage - title: class Module url: "/Module.html" output: web pdf @@ -418,10 +450,22 @@ entries: url: "/Net_TCPClient.html" output: web pdf type: homepage + - title: class PicoLine + url: "/PicoLine.html" + output: web pdf + type: homepage + - title: class PicoLine::Question + url: "/PicoLine_Question.html" + output: web pdf + type: homepage - title: class PicoRubyVM url: "/PicoRubyVM.html" output: web pdf type: homepage + - title: class PicoRubyVM::InstructionSequence + url: "/PicoRubyVM_InstructionSequence.html" + output: web pdf + type: homepage - title: class Prism url: "/Prism.html" output: web pdf @@ -514,6 +558,10 @@ entries: url: "/Watchdog.html" output: web pdf type: homepage + - title: module YAML + url: "/YAML.html" + output: web pdf + type: homepage - title: PRK Firmware output: web pdf folderitems: diff --git a/pages/rbs_doc/Base64.md b/pages/rbs_doc/Base64.md index c225a54..86cfe3e 100644 --- a/pages/rbs_doc/Base64.md +++ b/pages/rbs_doc/Base64.md @@ -18,3 +18,13 @@ Base64.decode64(String) -> String ```ruby Base64.encode64(String) -> String ``` +### urlsafe_decode64 + +```ruby +Base64.urlsafe_decode64(String) -> String +``` +### urlsafe_encode64 + +```ruby +Base64.urlsafe_encode64(String) -> String +``` diff --git a/pages/rbs_doc/Editor_Base.md b/pages/rbs_doc/Editor_Base.md index 9c7ecc7..6d9770c 100644 --- a/pages/rbs_doc/Editor_Base.md +++ b/pages/rbs_doc/Editor_Base.md @@ -19,6 +19,11 @@ Editor::Base.new-> void ```ruby instance.clear-> untyped ``` +### clear_buffer + +```ruby +instance.clear_buffer-> void +``` ### debug ```ruby diff --git a/pages/rbs_doc/GPIO_Error.md b/pages/rbs_doc/GPIO_Error.md new file mode 100644 index 0000000..501c36b --- /dev/null +++ b/pages/rbs_doc/GPIO_Error.md @@ -0,0 +1,15 @@ +--- +title: class GPIO::Error +keywords: GPIO::Error +tags: [class] +summary: GPIO::Error class of PicoRuby +sidebar: picoruby_sidebar +permalink: GPIO_Error.html +folder: rbs_doc +--- +## Singleton methods +### peripheral_error + +```ruby +GPIO::Error.peripheral_error(Integer code, ?String name) -> Integer +``` diff --git a/pages/rbs_doc/IO.md b/pages/rbs_doc/IO.md index 3325bc8..4f1d32a 100644 --- a/pages/rbs_doc/IO.md +++ b/pages/rbs_doc/IO.md @@ -75,6 +75,11 @@ IO.getc-> String? ```ruby IO.getch-> String ``` +### gets + +```ruby +IO.gets-> String +``` ### raw ```ruby diff --git a/pages/rbs_doc/IOError.md b/pages/rbs_doc/IOError.md index 7adff6e..cd4020e 100644 --- a/pages/rbs_doc/IOError.md +++ b/pages/rbs_doc/IOError.md @@ -7,9 +7,3 @@ sidebar: picoruby_sidebar permalink: IOError.html folder: rbs_doc --- -## Singleton methods -### peripheral_error - -```ruby -IOError.peripheral_error(Integer code, ?String name) -> Integer -``` diff --git a/pages/rbs_doc/JSON_DiggerError.md b/pages/rbs_doc/JSON_DiggerError.md new file mode 100644 index 0000000..80ff9bb --- /dev/null +++ b/pages/rbs_doc/JSON_DiggerError.md @@ -0,0 +1,9 @@ +--- +title: class JSON::DiggerError +keywords: JSON::DiggerError +tags: [class] +summary: JSON::DiggerError class of PicoRuby +sidebar: picoruby_sidebar +permalink: JSON_DiggerError.html +folder: rbs_doc +--- diff --git a/pages/rbs_doc/JSON_GeneratorError.md b/pages/rbs_doc/JSON_GeneratorError.md new file mode 100644 index 0000000..adfe2ae --- /dev/null +++ b/pages/rbs_doc/JSON_GeneratorError.md @@ -0,0 +1,9 @@ +--- +title: class JSON::GeneratorError +keywords: JSON::GeneratorError +tags: [class] +summary: JSON::GeneratorError class of PicoRuby +sidebar: picoruby_sidebar +permalink: JSON_GeneratorError.html +folder: rbs_doc +--- diff --git a/pages/rbs_doc/JSON_JSONError.md b/pages/rbs_doc/JSON_JSONError.md new file mode 100644 index 0000000..a8590c0 --- /dev/null +++ b/pages/rbs_doc/JSON_JSONError.md @@ -0,0 +1,9 @@ +--- +title: class JSON::JSONError +keywords: JSON::JSONError +tags: [class] +summary: JSON::JSONError class of PicoRuby +sidebar: picoruby_sidebar +permalink: JSON_JSONError.html +folder: rbs_doc +--- diff --git a/pages/rbs_doc/JSON_ParserError.md b/pages/rbs_doc/JSON_ParserError.md new file mode 100644 index 0000000..0a7fcda --- /dev/null +++ b/pages/rbs_doc/JSON_ParserError.md @@ -0,0 +1,9 @@ +--- +title: class JSON::ParserError +keywords: JSON::ParserError +tags: [class] +summary: JSON::ParserError class of PicoRuby +sidebar: picoruby_sidebar +permalink: JSON_ParserError.html +folder: rbs_doc +--- diff --git a/pages/rbs_doc/JWT.md b/pages/rbs_doc/JWT.md new file mode 100644 index 0000000..9eae179 --- /dev/null +++ b/pages/rbs_doc/JWT.md @@ -0,0 +1,20 @@ +--- +title: module JWT +keywords: JWT +tags: [module] +summary: JWT module of PicoRuby +sidebar: picoruby_sidebar +permalink: JWT.html +folder: rbs_doc +--- +## Singleton methods +### decode + +```ruby +JWT.decode(String token, ?String|nil secret, ?bool validate) -> [Object, Hash[String, Object]] +``` +### encode + +```ruby +JWT.encode(String payload, ?String|nil secret, ?String algorithm) -> String +``` diff --git a/pages/rbs_doc/JWT_VerificationError.md b/pages/rbs_doc/JWT_VerificationError.md new file mode 100644 index 0000000..4ebf765 --- /dev/null +++ b/pages/rbs_doc/JWT_VerificationError.md @@ -0,0 +1,9 @@ +--- +title: class JWT::VerificationError +keywords: JWT::VerificationError +tags: [class] +summary: JWT::VerificationError class of PicoRuby +sidebar: picoruby_sidebar +permalink: JWT_VerificationError.html +folder: rbs_doc +--- diff --git a/pages/rbs_doc/MbedTLS.md b/pages/rbs_doc/MbedTLS.md index f55314c..e7d4ab3 100644 --- a/pages/rbs_doc/MbedTLS.md +++ b/pages/rbs_doc/MbedTLS.md @@ -1,8 +1,8 @@ --- -title: class MbedTLS +title: module MbedTLS keywords: MbedTLS -tags: [class] -summary: MbedTLS class of PicoRuby +tags: [module] +summary: MbedTLS module of PicoRuby sidebar: picoruby_sidebar permalink: MbedTLS.html folder: rbs_doc diff --git a/pages/rbs_doc/MbedTLS_HMAC.md b/pages/rbs_doc/MbedTLS_HMAC.md new file mode 100644 index 0000000..d6a9f27 --- /dev/null +++ b/pages/rbs_doc/MbedTLS_HMAC.md @@ -0,0 +1,41 @@ +--- +title: class MbedTLS::HMAC +keywords: MbedTLS::HMAC +tags: [class] +summary: MbedTLS::HMAC class of PicoRuby +sidebar: picoruby_sidebar +permalink: MbedTLS_HMAC.html +folder: rbs_doc +--- +## Singleton methods +### new + +```ruby +MbedTLS::HMAC.new(String key, String digest) -> MbedTLS::HMAC +``` +## Instance methods +### digest + +```ruby +instance.digest() -> String +``` +### hexdigest + +```ruby +instance.hexdigest() -> String +``` +### reset + +```ruby +instance.reset() -> MbedTLS::HMAC +``` +### update + +```ruby +instance.update(String) -> MbedTLS::HMAC +``` +## Attr accessors +### _digest (accessor) +```ruby +instance._digest -> String +``` diff --git a/pages/rbs_doc/PicoLine.md b/pages/rbs_doc/PicoLine.md new file mode 100644 index 0000000..37d1251 --- /dev/null +++ b/pages/rbs_doc/PicoLine.md @@ -0,0 +1,20 @@ +--- +title: class PicoLine +keywords: PicoLine +tags: [class] +summary: PicoLine class of PicoRuby +sidebar: picoruby_sidebar +permalink: PicoLine.html +folder: rbs_doc +--- +## Instance methods +### ask + +```ruby +instance.ask(String) ?{ (Question) -> void } -> String +``` +## Attr accessors +### default (accessor) +```ruby +instance.default -> String? +``` diff --git a/pages/rbs_doc/PicoLine_Question.md b/pages/rbs_doc/PicoLine_Question.md new file mode 100644 index 0000000..a4b0e27 --- /dev/null +++ b/pages/rbs_doc/PicoLine_Question.md @@ -0,0 +1,18 @@ +--- +title: class PicoLine::Question +keywords: PicoLine::Question +tags: [class] +summary: PicoLine::Question class of PicoRuby +sidebar: picoruby_sidebar +permalink: PicoLine_Question.html +folder: rbs_doc +--- +## Attr accessors +### default (accessor) +```ruby +instance.default -> String +``` +### default_hint_show (accessor) +```ruby +instance.default_hint_show -> bool +``` diff --git a/pages/rbs_doc/PicoRubyVM.md b/pages/rbs_doc/PicoRubyVM.md index bf0dd57..ef9cef1 100644 --- a/pages/rbs_doc/PicoRubyVM.md +++ b/pages/rbs_doc/PicoRubyVM.md @@ -7,9 +7,23 @@ sidebar: picoruby_sidebar permalink: PicoRubyVM.html folder: rbs_doc --- +## Type aliases +### alloc_stat_t +```ruby +{total: Integer, used: Integer, free: Integer, frag: Integer} +``` +### alloc_prof_t +```ruby +{peak: Integer, valley: Integer} +``` ## Singleton methods ### memory_statistics ```ruby -PicoRubyVM.memory_statistics-> Hash[Symbol, Integer] +PicoRubyVM.memory_statistics-> alloc_stat_t +``` +### profile_alloc + +```ruby +PicoRubyVM.profile_alloc() {() -> untyped} -> untyped ``` diff --git a/pages/rbs_doc/PicoRubyVM_InstructionSequence.md b/pages/rbs_doc/PicoRubyVM_InstructionSequence.md new file mode 100644 index 0000000..142ad48 --- /dev/null +++ b/pages/rbs_doc/PicoRubyVM_InstructionSequence.md @@ -0,0 +1,31 @@ +--- +title: class PicoRubyVM::InstructionSequence +keywords: PicoRubyVM::InstructionSequence +tags: [class] +summary: PicoRubyVM::InstructionSequence class of PicoRuby +sidebar: picoruby_sidebar +permalink: PicoRubyVM_InstructionSequence.html +folder: rbs_doc +--- +## Singleton methods +### compile + +```ruby +PicoRubyVM::InstructionSequence.compile(String code) -> self +``` +### compile_file + +```ruby +PicoRubyVM::InstructionSequence.compile_file(String file) -> self +``` +## Instance methods +### eval + +```ruby +instance.eval() -> Object +``` +### to_binary + +```ruby +instance.to_binary() -> String +``` diff --git a/pages/rbs_doc/RNG.md b/pages/rbs_doc/RNG.md index f80ef26..a07f667 100644 --- a/pages/rbs_doc/RNG.md +++ b/pages/rbs_doc/RNG.md @@ -18,3 +18,8 @@ RNG.random_int-> Integer ```ruby RNG.random_string(Integer) -> String ``` +### uuid + +```ruby +RNG.uuid-> String +``` diff --git a/pages/rbs_doc/Task.md b/pages/rbs_doc/Task.md index 0ac8679..331ad44 100644 --- a/pages/rbs_doc/Task.md +++ b/pages/rbs_doc/Task.md @@ -8,39 +8,109 @@ permalink: Task.html folder: rbs_doc --- ## Singleton methods +### create + +```ruby +Task.create(String) -> Task +``` +### current + +```ruby +Task.current() -> Task +``` +### get + +```ruby +Task.get(String) -> Task +``` ### list ```ruby Task.list() -> Array[Task] ``` -### new +### name= + +```ruby +Task.name=(String) -> String +``` +### name_list + +```ruby +Task.name_list() -> Array[String] +``` +### pass + +```ruby +Task.pass() -> Task +``` +### priority= + +```ruby +Task.priority=(Integer) -> Task +``` +### status + +```ruby +Task.status() -> Task +``` +### suspend ```ruby -Task.new(*untyped) { (*untyped) -> void } -> instance +Task.suspend() -> Task +``` +### terminate + +```ruby +Task.terminate() -> Task ``` ## Instance methods ### join ```ruby -instance.join(?Integer|nil) -> (self | nil) +instance.join() -> void +``` +### name + +```ruby +instance.name() -> String ``` ### name= ```ruby -instance.name=(String name) -> String +instance.name=(String) -> self +``` +### priority= + +```ruby +instance.priority=(Integer) -> self +``` +### resume + +```ruby +instance.resume() -> self +``` +### rewind + +```ruby +instance.rewind() -> self +``` +### run + +```ruby +instance.run() -> void +``` +### status + +```ruby +instance.status() -> String ``` ### suspend ```ruby -instance.suspend() -> self +instance.suspend() -> void ``` ### terminate ```ruby instance.terminate() -> self ``` -## Attr accessors -### name (reader) -```ruby -instance.name -> String | nil -``` diff --git a/pages/rbs_doc/YAML.md b/pages/rbs_doc/YAML.md new file mode 100644 index 0000000..84225a4 --- /dev/null +++ b/pages/rbs_doc/YAML.md @@ -0,0 +1,20 @@ +--- +title: module YAML +keywords: YAML +tags: [module] +summary: YAML module of PicoRuby +sidebar: picoruby_sidebar +permalink: YAML.html +folder: rbs_doc +--- +## Singleton methods +### dump + +```ruby +YAML.dump(Object) -> String +``` +### load + +```ruby +YAML.load(String) -> Object +```