@startuml
scale 0.8
skinparam BackgroundColor transparent
skinparam componentStyle rectangle

node Resource {
     component "Version management" {

       component "Device update"#lightblue {
         [updates operations]
       }

       component "Device resources"#lightblue {
         [reported versions]#lightgrey
         [requested versions]
       }

     }
     component "Resource inventory"#lightblue {

       [versions]
       [resources]

     }
}
@enduml

@startuml "Resource Update context"
scale 0.8

participant "Customer" as customer

box "LiveObjects" #LightBlue
  participant "Resource manager" as rm
end box

participant "Device" as device

activate customer

== Resource management API ==

customer -> rm: define resources versions
rm --> rm: update versions

== Current resource version declaration ==

device -> rm: current resources
activate device
deactivate device


== Device resource management API ==

customer -> rm: set device resource requested version
rm --> rm: update requested version

customer -> rm: reset device resource requested version
rm --> rm: remove requested version

customer -> rm: list device resource versions

@enduml

@startuml
scale 0.6

  participant "Customer" as customer

  box "LiveObjects" #LightBlue
    participant "Resource manager" as rm
  end box

  participant "Device" as device

== 2 - New update ==

activate rm

alt #Lightgrey Customer initiative

  customer -> rm: create update
  rm --> rm: trigger an update

else #Lightyellow LiveObjects initiative

  device -> rm: connect & subscribe
  activate device
  rm --> rm: trigger an update
  note left
    eligible requested version
  end note
  hnote over rm #yellow : PENDING
  activate rm #FFBBBB
end

==3 - Prepare connector ==

  hnote over rm #yellow : PREPARING_CONNECTOR
  rm -> rm: prepare connector (file, link)

== 4 - Prepare asset ==

  hnote over rm #yellow : PREPARING_ASSET
rm -> device: update request [link,version]

  opt Device ack request
  device --> rm : accept
  end

== 5 - Transfer ==

alt Device download

  device -> rm: download
  note left
      whole or chunk
  end note
  rm -> rm: download progress
  hnote over rm #yellow : TRANSFER_IN_PROGRESS
  rm --> device: content
   hnote over rm #yellow : TRANSFER_SUCCESS

else #LightPink Update cancel

  customer -> rm: cancel update
  rm -> rm: cancel request, delete download link
  hnote over rm #yellow : CANCELED

else #LightPink Transfer timeout

  rm --> rm: update set as ERROR
  note left
    device never download.
  end note
    hnote over rm #yellow : ERROR

end

== 6 - Final ==

alt Device update

  device --> device: update
  note left
    device checks file integrity, updates internal resource and may reboot.
  end note
  device -> rm: current resources
  rm --> rm: check resource version
  alt #Lightgreen version match
    rm --> rm: update set as DONE
    hnote over rm #yellow : DONE
  else #Lightpink version mismatch
    rm --> rm: update set as ERROR
    hnote over rm #yellow : ERROR
  end

else #Lightpink Device side failure case

  device --> device: update failed
  note left
     device refused update request or was unable to perform update.
  end note
  device -> rm: update error
  rm --> rm: update set as ERROR
  hnote over rm #yellow : ERROR


else #LightPink Update timeout
rm --> rm: update set as ERROR
note left
  update takes too much time
end note
    hnote over rm #yellow : ERROR


end

@enduml

@startuml
scale 0.6

hide empty description

(*) --> [ START: update trigger] PENDING

if "//Waiting for device //"
	-[#yellow]-> [ Cancel resource update] CANCELED
else
	--> [ Device is connected and ready \n to receive firmware update] PREPARING_CONNECTOR

if "//UpdaterConnector response//"
	--> [download link is ready] PREPARING_ASSET
else
	-[#yellow]-> [Cancel resource update] CANCELED

PREPARING_ASSET -[#A9A9A9]-> [update request sent to the device] WAITING_TRANSFER_INFO

if "no request ack and no transfer timeout ?"
  -[#grey]-> [yes] PENDING
else
  if "ack received but transfer timeout ?"
    -[#orange]-> [yes] ERROR
  else
	--> [Updater connection open] TRANSFER_PENDING
  endif
endif

TRANSFER_PENDING --> [Download begins] TRANSFER_IN_PROGRESS

if "//Download in progress//"
	-[#yellow]-> [Force cancel]  CANCELED
else
	--> [100% transfered]  TRANSFER_SUCCESS
	if "//current resource version// \n //matches target version ?//"
		--> [yes] DONE
	else
		-[#orange]-> [no] ERROR
	ERROR#orange --> (*)
	DONE#lightgreen --> (*)
	CANCELED#yellow --> (*)

@enduml

@startuml
scale 0.6

  participant "Customer" as customer

  box "LiveObjects" #LightBlue
    participant "Resource manager" as rm
  end box

  participant "LW Device" as device

== 2 - New update ==

activate rm

  customer -> rm: create update
  note left
    Customer initiative
  end note
  rm --> rm: trigger an update
  hnote over rm #yellow : PENDING
  activate rm #FFBBBB

==3 - Prepare resource ==

  device --> rm : device online with /5/0 instance
  note left
    Conditions are ok
  end note
  activate device
  hnote over rm #yellow : PREPARING_CONNECTOR
  rm -> rm: prepare file [version]

== 4 - Prepare device ==

  hnote over rm #yellow : PREPARING_ASSET
       loop #lightyellow
        rm -> device: READ Firmware /5/0
          hnote over device
            FW state (3), protocol support(8), delivery method(9)
          end note

        alt #lightgreen read OK, state=IDLE, protocol supported, delivery method supported
          hnote over device #lightgreen : 0:IDLE
          device --> rm: state value
          hnote over rm #yellow : TRANSFER_PENDING
        else #LightPink http-updater: protocol or delivery method not supported
          rm --> rm: report error, update set as ERROR
          note left
            Device is not compatible
          end note
          hnote over rm #yellow : ERROR
        else #LightPink read not OK or state != idle and loop max retries reached
          rm --> rm: report error, update set as ERROR
          note left
            Device is not in state to update
          end note
          hnote over rm #yellow : ERROR
        else #lightyellow loop: read not OK or state != idle and loop max retries not reached
          rm --> rm: await X ms (X: exp. backoff from 30sec to 8h)
        end
      end

== option: interruption ==

opt #LightYellow Update cancel

  customer -> rm: cancel request
  rm --> rm: update set as CANCELED
  hnote over rm #yellow : CANCELED

else #LightPink Transfer timeout

  rm --> rm: update set as ERROR
  hnote over rm #yellow : ERROR

end

== 5 - Transfer ==
  rm -> rm: get resource version
  hnote over rm #yellow : TRANSFER_IN_PROGRESS

alt #lavenderblush lwm2m-updater (push)
  rm -> device: WRITE /5/0/0 Firmware package content
else #lavender http-updater (pull)
  rm -> device: WRITE /5/0/1 Firmware package URI
end
  hnote over device #lightgreen : 1:DOWNLOADING
  device --> rm: write result

alt #lavender http-updater (pull)
  rm <- device: read package content
end

== 6 - Transfer verify result ==

  loop while (download is not finished)
    rm -> device: READ /5/0/3, 5/0/5
    device --> rm: state, update result value
  end

  alt #lightgreen downloaded
    hnote over device #lightgreen : 2:DOWNLOADED
    note over device : state = 2:DOWNLOADED \nresult = 0:INITIAL
    rm --> rm: transfer success
    hnote over rm #yellow : TRANSFER_SUCCESS
  else #LightPink failed or max retries reached
    rm --> rm: report error, update set as ERROR
    hnote over rm #yellow : ERROR
  end

== 7 - Execute update ==

    rm -> device: EXECUTE /5/0/2
    device --> rm: execute result
  alt #LightPink execute failed
    rm --> rm: report error, update set as ERROR
    hnote over rm #yellow : ERROR
  end

== 8 - Await update result ==

  loop while (update not finished)
    rm -> device: READ /5/0/5
    device --> rm: update result value
  end

  alt #lightgreen success
    hnote over device #lightgreen : 1:UPDATED_SUCCESSFULLY
    rm --> rm: update success
    hnote over rm #yellow : DONE
  else #LightPink update failed or max retries reached
    rm --> rm: report error, update set as ERROR
    hnote over rm #yellow : ERROR
  end


@enduml

@startuml
scale 0.6
hide empty description

(*) --> [ START: update created] PENDING

if "//Waiting for device //"
	-[#yellow]-> [ Cancel resource update] CANCELED
else
	--> [ Device is connected  \n and support lw firmware object] PREPARING_CONNECTOR

if "//UpdaterConnector response//"
	--> [resource version is ready] PREPARING_ASSET
else
	-[#yellow]-> [Cancel resource update] CANCELED


PREPARING_ASSET --> [update request sent to the device, and read state] WAITING_TRANSFER_INFO
if "//READ state value//"
	-[#grey]-> [state is NOT 0:IDLE]  PENDING
else
    --> [device is 0:IDLE] TRANSFER_PENDING
else
    -[#orange]-> [read error or max read retries] ERROR
else

TRANSFER_PENDING --> [get resource version and transfer started*] TRANSFER_IN_PROGRESS
note on link
   transfer started:
    - push transfer : start writing package on Lwm2m device
    - pull transfer : provide package URI to Lwm2m device
end note

if "//READ firmware state//"
	-[#yellow]-> [Force cancel]  CANCELED
else
	-[#orange]-> [read error or max read retries] ERROR
else
	--> [state=2:DOWNLOADED and result=0:INITIAL]  TRANSFER_SUCCESS


if "//EXECUTE Firmware update//"
	--> [result=1:UPDATED_SUCCESSFULLY] DONE
else
	-[#orange]-> [read error or result >1 or max read retries] ERROR


	ERROR#orange --> (*)
	DONE#lightgreen --> (*)
	CANCELED#yellow --> (*)

@enduml