Default package

Get desktop application:
View/edit binary Protocol Buffers messages

AudioFrame with uri of the sample to be played and the channel number

Used in: Packet

• string uri = 1

  supports file://<path>, http(s)://<url> with .wav or .aiff files

• uint32 channel = 2

• bool stop = 3

  stops playback on specified channel if true

Used in: Packet

• ControlEventType type = 1

Used in: ControlEvent

• APP_SELECTED = 0

  Emitted by octopus when an app is displayed

• APP_DESELECTED = 1

  Emitted by octopus when the app is no longer displayed

• APP_STARTED = 2

  Emitted by apps when they start

• APP_STOPPED = 3

  Emitted by apps when they are finished. Eg to signal that the next app can be selected.

Used in: NanoPBOptions

• DS_AUTO = 0

  Select minimal size based on field type

• DS_1 = 1

  1 word; up to 15 byte fields, no arrays

• DS_2 = 2

  2 words; up to 4095 byte fields, 4095 entry arrays

• DS_4 = 4

  4 words; up to 2^32-1 byte fields, 2^16-1 entry arrays

• DS_8 = 8

  8 words; up to 2^32-1 entry arrays

Used in: FirmwareConfig

• LINEAR = 0

• EASE_IN_QUAD = 1

• EASE_OUT_QUAD = 2

• EASE_IN_OUT_QUAD = 3

• EASE_IN_CUBIC = 4

• EASE_OUT_CUBIC = 5

• EASE_IN_OUT_CUBIC = 6

• EASE_IN_QUART = 7

• EASE_OUT_QUART = 8

• EASE_IN_OUT_QUART = 9

• EASE_IN_QUINT = 10

• EASE_OUT_QUINT = 11

• EASE_IN_OUT_QUINT = 12

• EASE_IN_EXPO = 13

• EASE_OUT_EXPO = 14

• EASE_IN_OUT_EXPO = 15

Used in: NanoPBOptions

• FT_DEFAULT = 0

  Automatically decide field type, generate static field if possible.

• FT_CALLBACK = 1

  Always generate a callback field.

• FT_POINTER = 4

  Always generate a dynamically allocated field.

• FT_STATIC = 2

  Generate a static field or raise an exception if not possible.

• FT_IGNORE = 3

  Ignore the field completely.

• FT_INLINE = 5

  Legacy option, use the separate 'fixed_length' option instead

Used in: Packet

• uint32 luminance = 1

• EasingMode easing_mode = 2

• bool show_test_frame = 3

• uint32 config_phash = 4

• bool enable_calibration = 5

Used in: FirmwarePacket

• string hostname = 1

• string build_time = 2

• uint32 panel_index = 3

• uint32 frames_per_second = 4

• uint32 config_phash = 5

• string mac = 6

• string ipv4 = 7

• string ipv6_local = 8

• string ipv6_global = 9

• uint32 packets_per_second = 10

• uint64 uptime = 11

• uint32 heap_size = 12

• uint32 free_heap = 13

• uint32 proximity_readings_per_second = 14

From Firmware to Octopus, internal use only

• oneof content

  • FirmwareInfo firmware_info = 1

  • RemoteLog remote_log = 2

  • ProximityEvent proximity_event = 3

Used in: Packet

• InputType type = 1

• int32 value = 3

  0 or 1 for buttons, -1 to 1 for directions

Used in: Packet

• InputType type = 1

• int32 duration = 2

  in milliseconds

Used in: InputEvent, InputLightEvent

• BUTTON_1 = 0

• BUTTON_2 = 1

• BUTTON_3 = 2

• BUTTON_4 = 3

• BUTTON_5 = 4

• BUTTON_6 = 5

• BUTTON_7 = 6

• BUTTON_8 = 7

• BUTTON_9 = 8

• BUTTON_10 = 9

• BUTTON_11 = 17

• BUTTON_12 = 18

• AXIS_X_1 = 10

• AXIS_Y_1 = 11

• AXIS_X_2 = 12

• AXIS_Y_2 = 13

• BUTTON_A_1 = 14

• BUTTON_A_2 = 15

• BUTTON_MENU = 16

Used in: NanoPBOptions

• IS_DEFAULT = 0

  Default, 32/64bit based on type in .proto

• IS_8 = 8

• IS_16 = 16

• IS_32 = 32

• IS_64 = 64

This is the inner options message, which basically defines options for a field. When it is used in message or file scope, it applies to all fields.

• optional int32 max_size = 1

  Allocated size for 'bytes' and 'string' fields. For string fields, this should include the space for null terminator.

• optional int32 max_length = 14

  Maximum length for 'string' fields. Setting this is equivalent to setting max_size to a value of length+1.

• optional int32 max_count = 2

  Allocated number of entries in arrays ('repeated' fields)

• optional IntSize int_size = 7

  Size of integer fields. Can save some memory if you don't need full 32 bits for the value.

• optional FieldType type = 3

  Force type of field (callback or static allocation)

• optional bool long_names = 4

  Use long names for enums, i.e. EnumName_EnumValue.

• optional bool packed_struct = 5

  Add 'packed' attribute to generated structs. Note: this cannot be used on CPUs that break on unaligned accesses to variables.

• optional bool packed_enum = 10

  Add 'packed' attribute to generated enums.

• optional bool skip_message = 6

  Skip this message

• optional bool no_unions = 8

  Generate oneof fields as normal optional fields instead of union.

• optional uint32 msgid = 9

  integer type tag for a message

• optional bool anonymous_oneof = 11

  decode oneof as anonymous union

• optional bool proto3 = 12

  Proto3 singular field does not generate a "has_" flag

• optional bool proto3_singular_msgs = 21

  Force proto3 messages to have no "has_" flag. This was default behavior until nanopb-0.4.0.

• optional bool enum_to_string = 13

  Generate an enum->string mapping function (can take up lots of space).

• optional bool fixed_length = 15

  Generate bytes arrays with fixed length

• optional bool fixed_count = 16

  Generate repeated field with fixed count

• optional bool submsg_callback = 22

  Generate message-level callback that is called before decoding submessages. This can be used to set callback fields for submsgs inside oneofs.

• optional TypenameMangling mangle_names = 17

  Shorten or remove package names from type names. This option applies only on the file level.

• optional string callback_datatype = 18

  Data type for storage associated with callback fields.

• optional string callback_function = 19

  Callback function used for encoding and decoding. Prior to nanopb-0.4.0, the callback was specified in per-field pb_callback_t structure. This is still supported, but does not work inside e.g. oneof or pointer fields. Instead, a new method allows specifying a per-message callback that will be called for all callback fields in a message type.

• optional DescriptorSize descriptorsize = 20

  Select the size of field descriptors. This option has to be defined for the whole message, not per-field. Usually automatic selection is ok, but if it results in compilation errors you can increase the field size here.

• optional bool default_has = 23

  Set default value for has_ fields.

• repeated string include = 24

  Extra files to include in generated `.pb.h`

• repeated string exclude = 26

  Automatic includes to exclude from generated `.pb.h` Same as nanopb_generator.py command line flag -x.

• optional string package = 25

  Package name that applies only for nanopb.

• optional google.protobuf.FieldDescriptorProto.Type type_override = 27

  Override type of the field in generated C code. Only to be used with related field types

• optional bool sort_by_tag = 28

  Due to historical reasons, nanopb orders fields in structs by their tag number instead of the order in .proto. Set this to false to keep the .proto order. The default value will probably change to false in nanopb-0.5.0.

• optional FieldType fallback_type = 29

  Set the FT_DEFAULT field conversion strategy. A field that can become a static member of a c struct (e.g. int, bool, etc) will be a a static field. Fields with dynamic length are converted to either a pointer or a callback.

wrapper for all messages

• oneof content

  • WFrame w_frame = 3

    Frames with pixel data.

  • RGBFrame rgb_frame = 4

  • AudioFrame audio_frame = 5

    Frames with audio data

  • SynthFrame synth_frame = 10

  • InputEvent input_event = 6

    Events from the input controllers

  • InputLightEvent input_light_event = 15

  • ControlEvent control_event = 9

    Events around controlling apps

  • FirmwareConfig firmware_config = 1

    ** Internal use only **

  • RGBFrame rgb_frame_part1 = 7

  • RGBFrame rgb_frame_part2 = 8

  • SoundToLightControlEvent sound_to_light_control_event = 11

Used in: FirmwarePacket

• uint32 panel_index = 1

• uint32 sensor_index = 2

• float distance_mm = 3

Frame with 3 bytes per pixel (RGB)

Used in: Packet

• bytes data = 1

  Series of RGB values. 8bit per color. First pixel is top left. One panel after the other.

• uint32 easing_interval = 2

  Optional. In milliseconds. Fade this frame over the previous one with an easing curve. Colors are blended in gamma corrected RGB space.

• bool keep_w = 3

  If true, any existing W data will be retained and mixed with this RGB frame.

Used in: FirmwarePacket

• string message = 1

Used in: Packet

• float bass = 1

• float mid = 2

• float high = 3

Used in: SynthConfig

• float attack = 1

• float decay = 2

• float sustain = 3

• float release = 4

Used in: SynthFrame

• SynthWaveform wave_form = 1

• float gain = 2

• optional SynthAdsrConfig adsr_config = 3

• optional SynthAdsrConfig filter_adsr_config = 4

• SynthFilterType filter_type = 5

• float cutoff = 6

• float resonance = 7

• optional SynthReverbConfig reverb_config = 8

Used in: SynthFrame

• CONFIG = 0

• NOTE_ON = 1

• NOTE_OFF = 2

Used in: SynthConfig

• BANDPASS = 0

• HIGHPASS = 1

• LOWPASS = 2

Used in: Packet

• SynthEventType event_type = 1

• uint32 channel = 2

• uint32 note = 3

• float velocity = 4

• float duration_ms = 5

• optional SynthConfig config = 6

Used in: SynthConfig

• float room_size = 1

• float width = 2

• float damping = 3

• float freeze_mode = 4

• float wet_level = 5

Used in: SynthConfig

• SINE = 0

• SAW = 1

• SQUARE = 2

Used in: NanoPBOptions

• M_NONE = 0

  Default, no typename mangling

• M_STRIP_PACKAGE = 1

  Strip current package name

• M_FLATTEN = 2

  Only use last path component

• M_PACKAGE_INITIALS = 3

  Replace the package name by the initials

Frame that uses only the white channel, 1 byte per pixel.

Used in: Packet

• bytes data = 1

  Selects pixel colors from the palette. First pixel is top left. One panel after the other.

• uint32 easing_interval = 3

  Optional. In milliseconds. Fade this frame over the previous one with an easing curve. Colors are blended in gamma corrected RGB space.

• bool keep_rgb = 4

  If true, any existing RGB data will be retained and mixed with this.